OPAL
Static Public Member Functions | Public Attributes | Friends | List of all members
OPALSettings Struct Reference

A lightweight class containing various OPAL options. More...

#include <OPALSettings.h>

Static Public Member Functions

static OPALSettings GetDefaults ()
 
static OPALSettings ReadFromFile (const std::string &fileName)
 Read settings from plain text file. More...
 

Public Attributes

size_t initWindowRadius
 Radius of initialization window. More...
 
size_t initWindowSide
 Side of inittialization window. initWindowSide = 2 * initWindowRadis + 1.
 
size_t patchRadius
 Radius of patches OPAL operates with. More...
 
size_t patchSide
 Side of OPAL patches. patchSide = 2 * patchRadis + 1.
 
bool intermediateSaving
 Enable/disable intermediate saving.
 
std::string intermediateSavingPath
 Path to save intermediate results.
 
size_t maxIterations
 Maximum number of iterations performed.
 

Friends

std::ostream & operator<< (std::ostream &os, const OPALSettings &sets)
 Plain text dumping of all parameters to output stream. More...
 

Detailed Description

A lightweight class containing various OPAL options.

Member Function Documentation

§ GetDefaults()

OPALSettings OPALSettings::GetDefaults ( )
static
Returns
Default values for all settings.

§ ReadFromFile()

OPALSettings OPALSettings::ReadFromFile ( const std::string &  fileName)
static

Read settings from plain text file.

Values are separated by '='.

Parameters
[in]fileNameName of settings file.

Friends And Related Function Documentation

§ operator<<

std::ostream& operator<< ( std::ostream &  os,
const OPALSettings sets 
)
friend

Plain text dumping of all parameters to output stream.

Parameters
[out]osOutput stream.
[in]setsOPAL settings to dump.

Member Data Documentation

§ initWindowRadius

size_t OPALSettings::initWindowRadius

Radius of initialization window.

Window is square, each side (2 * initWindowRadius + 1) pixels.

§ patchRadius

size_t OPALSettings::patchRadius

Radius of patches OPAL operates with.

Each patch is square with (2 * patchRadius + 1) pixels on side.


The documentation for this struct was generated from the following files: