Contrast Class Reference
[Common classes.]

Type of the input contrast. More...

#include <common.h>

List of all members.

Public Types

enum  Cntype {
  ABS,
  REF,
  PHS,
  FLT
}
 

Known contrast types.

More...

Public Member Functions

 Contrast (Cntype _cn=FLT)
 Constructor from contrast type.
 Contrast (const std::string &_name)
 Constructor from name.
Cntype contrast () const
 Contrast type.
std::string name () const
 Name of the contrast type.

Static Public Attributes

static const std::string Desc
 Description of the option giving the contrast type.

Private Attributes

Cntype _contrast
 Type of the contrast.

Static Private Attributes

static const std::string modname = "contrast"
 Module name.

Detailed Description

Type of the input contrast.

Affects the behaviour of the reconstruction algorithm. See the CTRec class for more details.

When you need to include your own type of contrast follow these steps:

  1. Add your contrast to the Contrast::Cntype enumeration.
  2. Add your contrast to the Contrast::Contrast(const std::string &) constructor
  3. Add your contrast to the Contrast::name() method.
  4. Update the ContrastOptionDesc string as appropriate.

Definition at line 245 of file common.h.


Member Enumeration Documentation

Known contrast types.

Enumerator:
ABS 

Absorption.

REF 

Refraction.

PHS 

Phase.

FLT 

Pre-filtered: ready for backprojection, no filtering needed.

Definition at line 249 of file common.h.


Constructor & Destructor Documentation

Contrast::Contrast ( Cntype  _cn = FLT  ) 

Constructor from contrast type.

Constructor.

Parameters:
_cn Contrast type.

Definition at line 279 of file common.cpp.

Contrast::Contrast ( const std::string &  _name  ) 

Constructor from name.

Parameters:
_name Contrast name.

Definition at line 285 of file common.cpp.

References _contrast, ABS, FLT, name(), PHS, REF, throw_error(), and upper().


Member Function Documentation

Contrast::Cntype Contrast::contrast (  )  const

Contrast type.

Type of contrast.

Returns:
Type of contrast

Definition at line 300 of file common.cpp.

References _contrast.

Referenced by CTrec::choose_algorithm(), operator!=(), and operator==().

string Contrast::name (  )  const

Name of the contrast type.

Name of the contrast.

Returns:
Name of the contrast.

Definition at line 310 of file common.cpp.

References _contrast, ABS, FLT, PHS, REF, and throw_bug().

Referenced by CTrec::choose_algorithm(), and Contrast().


Member Data Documentation

Type of the contrast.

Definition at line 258 of file common.h.

Referenced by contrast(), Contrast(), and name().

const std::string Contrast::Desc [static]
Initial value:
            "Must be one of the following strings (case insensitive):\n"
            "A, ABS, ABSORPTION - for the absorption contrast\n"
            "R, REF, REFRACTION - for the refraction contrast\n"
            "P, PHS, PHASE      - for the phase contrast\n"
            "F, FLT, FILTERED   - for the pre-filtered contrast"

Description of the option giving the contrast type.

Definition at line 268 of file common.h.

const string Contrast::modname = "contrast" [static, private]

Module name.

Definition at line 257 of file common.h.


The documentation for this class was generated from the following files:
Generated on Thu Jul 29 15:34:27 2010 for ctas by  doxygen 1.6.3