ost::img Namespace Reference

Namespaces

namespace  alg
namespace  detail
namespace  gui
namespace  image_state
namespace  physics
namespace  util

Data Structures

class  CircleMask
class  OpBase
class  AndOp
class  OrOp
class  XorOp
class  CompositeMask
class  ConstData
 Abstract base class for read-only data. More...
class  Data
 Abstract base class for data. More...
class  AlgorithmBase
 Algorithm base class. More...
class  NonModAlgorithm
 Non-modifying Algorithm, abstract base class. More...
class  ModIPAlgorithm
 In-place modification algorithm. More...
class  ConstModIPAlgorithm
 In-place modification const algorithm. More...
class  ModOPAlgorithm
 out-of-place modification algorithm More...
class  ConstModOPAlgorithm
 out-of-place modification const algorithm More...
class  InvalidObserver
class  DataObserver
 Abstract base class of data observer. More...
struct  InvalidExtentException
class  Extent
 Defines lower and upper valid indices. More...
class  ExtentIterator
 Extent iterator. More...
class  ExtentMask
class  InvalidImageHandle
 Exception thrown upon invalid image handle usage. More...
class  ImageHandle
 Manage shared instances of images. More...
class  ConstImageHandle
 read-only ImageHandle implementation More...
class  ImageList
 Manages a collection of images. More...
class  InvertedMask
class  MaskBase
class  MaskVisitor
class  NormalizeFnc
 Abstract normalizer base class. More...
class  NormalizerImpl
class  NoOpNormalizer
class  RangeHandler
class  NullData
 null data singleton More...
class  Observable
 templated observable class More...
class  Peak
class  Phase
 Manages phases og Complex numbers. More...
class  InvalidSampling
class  PixelSampling
 Helper class to handle pixel sampling. More...
class  Point
 class encapsulating 1D to 3D point More...
class  PointList
 list of points More...
class  PolygonMask
class  Progress
class  RasterImage
 Generic raster image. More...
class  Size
 class encapsulating 1D to 3D size More...
class  SphericalMask

Typedefs

typedef boost::shared_ptr< OpBase > OpPtr
typedef boost::shared_ptr
< ImageStateBasePtr > 		ImageImpl
typedef ImageHandle MapHandle = ImageHandle
typedef boost::shared_ptr
< MaskBase > 		MaskPtr
typedef boost::shared_ptr
< NormalizerImpl > 		NormalizerPtr
typedef
ImageStateConstModIPAlgorithm
< NormalizeFnc > 		NormalizerBase
typedef std::vector< Peak > PeakList
typedef
boost::variate_generator
< boost::mt19937
&, boost::uniform_int<> > 		UniformIntGenerator

Enumerations

enum  DataType { REAL = 0, COMPLEX, WORD, DEFAULTTYPE }
enum  DataDomain { SPATIAL = 0, FREQUENCY, HALF_FREQUENCY, DEFAULTDOMAIN }
enum  DivZeroMethod { SET_ZERO = 0, DIV_EPS = 1, INTERPOLATE }
enum  DomainToColorMode { MODULUS, PHASECOLOR }

Functions

DLLEXPORT_OST_IMG_BASE bool HasOverlap (const Extent &e1, const Extent &e2)
DLLEXPORT_OST_IMG_BASE Extent Overlap (const Extent &e1, const Extent &e2)
DLLEXPORT_OST_IMG_BASE
std::ostream & 		operator<< (std::ostream &os, const img::Extent &b)
ImageHandle DLLEXPORT_OST_IMG_BASE CreateImage (const Extent &ext=Extent(), DataType type=REAL, DataDomain dom=SPATIAL)
ImageHandle DLLEXPORT_OST_IMG_BASE CreateImage (const Size &s, DataType type=REAL, DataDomain dom=SPATIAL)
ImageHandle DLLEXPORT_OST_IMG_BASE CreateImage (const Size &s, const Point &o, DataType type=REAL, DataDomain dom=SPATIAL)
ImageHandle DLLEXPORT_OST_IMG_BASE CreateImage (const Point &p1, const Point &p2, DataType type=REAL, DataDomain dom=SPATIAL)
ImageHandle DLLEXPORT_OST_IMG_BASE CreateImage (const Point &p1, const Size &s, DataType type=REAL, DataDomain dom=SPATIAL)
ImageHandle DLLEXPORT_OST_IMG_BASE GenerateImage (const Data &d)
ImageHandle DLLEXPORT_OST_IMG_BASE GenerateImage (const Data &d, const Extent &e)
ImageImpl CreateImageImpl (const Extent &, DataType type, DataDomain dom)
ImageHandle DLLEXPORT_OST_IMG_BASE CreateMap (const Extent &ext=Extent(), DataType type=REAL, DataDomain dom=SPATIAL)
ImageHandle DLLEXPORT_OST_IMG_BASE CreateMap (const Size &s, const Point &o, DataType type=REAL, DataDomain dom=SPATIAL)
ImageHandle DLLEXPORT_OST_IMG_BASE CreateMap (const Point &p1, const Point &p2, DataType type=REAL, DataDomain dom=SPATIAL)
ImageHandle DLLEXPORT_OST_IMG_BASE CreateMap (const Point &p1, const Size &s, DataType type=REAL, DataDomain dom=SPATIAL)
MaskPtr DLLEXPORT_OST_IMG_BASE Mask (const Polygon2 &p)
MaskPtr DLLEXPORT_OST_IMG_BASE Mask (const Extent &e)
MaskPtr DLLEXPORT_OST_IMG_BASE Mask (const Circle2 &c)
MaskPtr DLLEXPORT_OST_IMG_BASE Mask (const Sphere &s)
MaskPtr DLLEXPORT InfoToMask (const info::InfoGroup &g)
void DLLEXPORT MaskToInfo (const MaskPtr &mptr, info::InfoGroup &g)
DLLEXPORT_OST_IMG_BASE MaskPtr operator~ (const MaskPtr &mptr)
DLLEXPORT_OST_IMG_BASE MaskPtr operator& (const MaskPtr &lhs, const MaskPtr &rhs)
DLLEXPORT_OST_IMG_BASE MaskPtr operator| (const MaskPtr &lhs, const MaskPtr &rhs)
DLLEXPORT_OST_IMG_BASE MaskPtr operator^ (const MaskPtr &lhs, const MaskPtr &rhs)
DLLIMPORT PeakList ImportPeakList (const String &filename)
DLLIMPORT void ExportPeakList (const PeakList &l, const String &filename)
DLLIMPORT std::ostream & operator<< (std::ostream &, const Phase a)
DLLIMPORT std::ostream & operator<< (std::ostream &os, const Point &p)
DLLIMPORT Size operator+ (const Size &s1, const Size &s2)
DLLIMPORT Size operator- (const Size &s1, const Size &s2)
DLLIMPORT std::ostream & operator<< (std::ostream &os, const Size &s)
template<typename T >
DLLIMPORT T Random ()
template<>
Complex Random< Complex > ()
template<>
Word Random< Word > ()
UniformIntGenerator GetUniformIntGenerator (int min, int max)
template<typename V , typename R >
DLLIMPORT R Val2Val (const V &v)
template<>
Real Val2Val< Complex, Real > (const Complex &c)
template<>
Word Val2Val< Complex, Word > (const Complex &c)
template<typename T >
DLLIMPORT DataType Val2Type ()
template<>
DataType Val2Type< Complex > ()
template<>
DataType Val2Type< Real > ()
template<>
DataType Val2Type< Word > ()
template<typename T >
DLLIMPORT String Val2String ()
template<>
String Val2String< Complex > ()
template<>
String Val2String< Real > ()
template<>
String Val2String< Word > ()
Global operators

These operators are implemented in terms of the member operators of ImageHandle, and due to the implicit convertability of ImageHandle to ConstImageHandle, they may be applied to both handle variants.



DLLEXPORT_OST_IMG_BASE bool operator== (const ImageHandle &lhs, const ConstImageHandle &rhs)
DLLEXPORT_OST_IMG_BASE bool operator!= (const ImageHandle &lhs, const ConstImageHandle &rhs)
DLLEXPORT_OST_IMG_BASE ImageHandle operator+ (const ConstImageHandle &h, Real v)
DLLEXPORT_OST_IMG_BASE ImageHandle operator+ (const ConstImageHandle &h, const Complex &v)
DLLEXPORT_OST_IMG_BASE ImageHandle operator+ (Real v, const ConstImageHandle &h)
DLLEXPORT_OST_IMG_BASE ImageHandle operator+ (const Complex &v, const ConstImageHandle &h)
DLLEXPORT_OST_IMG_BASE ImageHandle operator- (const ConstImageHandle &h, Real v)
DLLEXPORT_OST_IMG_BASE ImageHandle operator- (const ConstImageHandle &h, const Complex &v)
DLLEXPORT_OST_IMG_BASE ImageHandle operator- (Real v, const ConstImageHandle &h)
DLLEXPORT_OST_IMG_BASE ImageHandle operator- (const Complex &v, const ConstImageHandle &h)
DLLEXPORT_OST_IMG_BASE ImageHandle operator* (const ConstImageHandle &h, Real v)
DLLEXPORT_OST_IMG_BASE ImageHandle operator* (const ConstImageHandle &h, const Complex &v)
DLLEXPORT_OST_IMG_BASE ImageHandle operator* (Real v, const ConstImageHandle &h)
DLLEXPORT_OST_IMG_BASE ImageHandle operator* (const Complex &v, const ConstImageHandle &h)
DLLEXPORT_OST_IMG_BASE ImageHandle operator/ (const ConstImageHandle &h, Real v)
DLLEXPORT_OST_IMG_BASE ImageHandle operator/ (const ConstImageHandle &h, const Complex &v)
DLLEXPORT_OST_IMG_BASE ImageHandle operator+ (const ConstImageHandle &h1, const ConstImageHandle &h2)
DLLEXPORT_OST_IMG_BASE ImageHandle operator- (const ConstImageHandle &h1, const ConstImageHandle &h2)
DLLEXPORT_OST_IMG_BASE ImageHandle operator* (const ConstImageHandle &h1, const ConstImageHandle &h2)
DLLEXPORT_OST_IMG_BASE ImageHandle operator/ (const ConstImageHandle &h1, const ConstImageHandle &h2)

Typedef Documentation

typedef boost::shared_ptr<ImageStateBasePtr> ImageImpl

Definition at line 38 of file image_impl.hh.

MapHandle = ImageHandle

Definition at line 26 of file map.hh.

typedef boost::shared_ptr<MaskBase> MaskPtr

Definition at line 28 of file mask_base_fw.hh.

typedef ImageStateConstModIPAlgorithm<NormalizeFnc> NormalizerBase

Definition at line 66 of file normalizer_impl.hh.

typedef boost::shared_ptr<NormalizerImpl> NormalizerPtr

Definition at line 32 of file normalizer_fw.hh.

typedef boost::shared_ptr<OpBase> OpPtr

Definition at line 64 of file composite_mask.hh.

typedef std::vector<Peak> PeakList

Definition at line 46 of file peak.hh.

typedef boost::variate_generator<boost::mt19937&, boost::uniform_int<> > UniformIntGenerator

Definition at line 72 of file value_util.hh.

Enumeration Type Documentation

enum DataDomain

underlying data type

Enumerator:
SPATIAL 
FREQUENCY 
HALF_FREQUENCY 
DEFAULTDOMAIN 

Definition at line 42 of file data_types.hh.

enum DataType
Enumerator:
REAL 
COMPLEX 
WORD 
DEFAULTTYPE 

Definition at line 37 of file data_types.hh.

enum DivZeroMethod

data domain

Enumerator:
SET_ZERO 
DIV_EPS 
INTERPOLATE 

Definition at line 51 of file data_types.hh.

enum DomainToColorMode
Enumerator:
MODULUS 
PHASECOLOR 

Definition at line 56 of file data_types.hh.

Function Documentation

ImageHandle DLLEXPORT_OST_IMG_BASE ost::img::CreateImage ( const Point &  p1,
const Size &  s,
DataType  type = REAL,
DataDomain  dom = SPATIAL 
)
ImageHandle DLLEXPORT_OST_IMG_BASE ost::img::CreateImage ( const Point &  p1,
const Point &  p2,
DataType  type = REAL,
DataDomain  dom = SPATIAL 
)
ImageHandle DLLEXPORT_OST_IMG_BASE ost::img::CreateImage ( const Size &  s,
const Point &  o,
DataType  type = REAL,
DataDomain  dom = SPATIAL 
)
ImageHandle DLLEXPORT_OST_IMG_BASE ost::img::CreateImage ( const Size &  s,
DataType  type = REAL,
DataDomain  dom = SPATIAL 
)

convenience variants to create images

ImageHandle DLLEXPORT_OST_IMG_BASE ost::img::CreateImage ( const Extent &  ext = Extent(),
DataType  type = REAL,
DataDomain  dom = SPATIAL 
)

Create image from scratch.

A handle to a newly created handle is returned. The image is defined by an Extent, the type (REAL (default) or COMPLEX), and the domain (SPATIAL (default), FREQUENCY or HALF_FREQUENCY ).

ImageImpl ost::img::CreateImageImpl ( const Extent &  ,
DataType  type,
DataDomain  dom 
)
ImageHandle DLLEXPORT_OST_IMG_BASE ost::img::CreateMap ( const Point &  p1,
const Size &  s,
DataType  type = REAL,
DataDomain  dom = SPATIAL 
)
ImageHandle DLLEXPORT_OST_IMG_BASE ost::img::CreateMap ( const Point &  p1,
const Point &  p2,
DataType  type = REAL,
DataDomain  dom = SPATIAL 
)
ImageHandle DLLEXPORT_OST_IMG_BASE ost::img::CreateMap ( const Size &  s,
const Point &  o,
DataType  type = REAL,
DataDomain  dom = SPATIAL 
)

convenience variant to create images

ImageHandle DLLEXPORT_OST_IMG_BASE ost::img::CreateMap ( const Extent &  ext = Extent(),
DataType  type = REAL,
DataDomain  dom = SPATIAL 
)
DLLIMPORT void ost::img::ExportPeakList ( const PeakList &  l,
const String &  filename 
)
ImageHandle DLLEXPORT_OST_IMG_BASE ost::img::GenerateImage ( const Data &  d,
const Extent &  e 
)

Create image based on some data object (ie other image or function).

The returned image will have the extent given by second parameter

ImageHandle DLLEXPORT_OST_IMG_BASE ost::img::GenerateImage ( const Data &  d  ) 

Create image based on some data object (ie other image or function).

UniformIntGenerator ost::img::GetUniformIntGenerator ( int  min,
int  max 
) [inline]

Definition at line 75 of file value_util.hh.

DLLEXPORT_OST_IMG_BASE bool ost::img::HasOverlap ( const Extent &  e1,
const Extent &  e2 
)
DLLIMPORT PeakList ost::img::ImportPeakList ( const String &  filename  ) 
MaskPtr DLLEXPORT ost::img::InfoToMask ( const info::InfoGroup &  g  ) 
MaskPtr DLLEXPORT_OST_IMG_BASE ost::img::Mask ( const Sphere &  s  ) 
MaskPtr DLLEXPORT_OST_IMG_BASE ost::img::Mask ( const Circle2 &  c  ) 
MaskPtr DLLEXPORT_OST_IMG_BASE ost::img::Mask ( const Extent &  e  ) 
MaskPtr DLLEXPORT_OST_IMG_BASE ost::img::Mask ( const Polygon2 &  p  ) 
void DLLEXPORT ost::img::MaskToInfo ( const MaskPtr &  mptr,
info::InfoGroup &  g 
)
DLLEXPORT_OST_IMG_BASE bool ost::img::operator!= ( const ImageHandle &  lhs,
const ConstImageHandle &  rhs 
)
DLLEXPORT_OST_IMG_BASE MaskPtr ost::img::operator& ( const MaskPtr &  lhs,
const MaskPtr &  rhs 
)
DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator* ( const ConstImageHandle &  h1,
const ConstImageHandle &  h2 
)
DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator* ( const Complex &  v,
const ConstImageHandle &  h 
)
DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator* ( Real  v,
const ConstImageHandle &  h 
)
DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator* ( const ConstImageHandle &  h,
const Complex &  v 
)
DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator* ( const ConstImageHandle &  h,
Real  v 
)
DLLIMPORT Size ost::img::operator+ ( const Size &  s1,
const Size &  s2 
)
DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator+ ( const ConstImageHandle &  h1,
const ConstImageHandle &  h2 
)
DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator+ ( const Complex &  v,
const ConstImageHandle &  h 
)
DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator+ ( Real  v,
const ConstImageHandle &  h 
)
DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator+ ( const ConstImageHandle &  h,
const Complex &  v 
)
DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator+ ( const ConstImageHandle &  h,
Real  v 
)
DLLIMPORT Size ost::img::operator- ( const Size &  s1,
const Size &  s2 
)
DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator- ( const ConstImageHandle &  h1,
const ConstImageHandle &  h2 
)
DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator- ( const Complex &  v,
const ConstImageHandle &  h 
)
DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator- ( Real  v,
const ConstImageHandle &  h 
)
DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator- ( const ConstImageHandle &  h,
const Complex &  v 
)
DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator- ( const ConstImageHandle &  h,
Real  v 
)
DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator/ ( const ConstImageHandle &  h1,
const ConstImageHandle &  h2 
)
DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator/ ( const ConstImageHandle &  h,
const Complex &  v 
)
DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator/ ( const ConstImageHandle &  h,
Real  v 
)
DLLIMPORT std::ostream& ost::img::operator<< ( std::ostream &  os,
const Size &  s 
)
DLLIMPORT std::ostream& ost::img::operator<< ( std::ostream &  os,
const Point &  p 
)
DLLIMPORT std::ostream& ost::img::operator<< ( std::ostream &  ,
const Phase  a 
)
DLLEXPORT_OST_IMG_BASE std::ostream& ost::img::operator<< ( std::ostream &  os,
const img::Extent &  b 
)
DLLEXPORT_OST_IMG_BASE bool ost::img::operator== ( const ImageHandle &  lhs,
const ConstImageHandle &  rhs 
)
DLLEXPORT_OST_IMG_BASE MaskPtr ost::img::operator^ ( const MaskPtr &  lhs,
const MaskPtr &  rhs 
)
DLLEXPORT_OST_IMG_BASE MaskPtr ost::img::operator| ( const MaskPtr &  lhs,
const MaskPtr &  rhs 
)
DLLEXPORT_OST_IMG_BASE MaskPtr ost::img::operator~ ( const MaskPtr &  mptr  ) 
DLLEXPORT_OST_IMG_BASE Extent ost::img::Overlap ( const Extent &  e1,
const Extent &  e2 
)
T Random (  )  [inline]

Definition at line 68 of file value_util.hh.

Complex ost::img::Random< Complex > (  )  [inline]
Word ost::img::Random< Word > (  )  [inline]
DLLIMPORT String ost::img::Val2String (  )  [inline]
String ost::img::Val2String< Complex > (  )  [inline]
String ost::img::Val2String< Real > (  )  [inline]
String ost::img::Val2String< Word > (  )  [inline]
DLLIMPORT DataType ost::img::Val2Type (  )  [inline]
DataType ost::img::Val2Type< Complex > (  )  [inline]
DataType ost::img::Val2Type< Real > (  )  [inline]
DataType ost::img::Val2Type< Word > (  )  [inline]
R Val2Val ( const V &  v  )  [inline]

Definition at line 100 of file value_util.hh.

Real ost::img::Val2Val< Complex, Real > ( const Complex &  c  )  [inline]
Word ost::img::Val2Val< Complex, Word > ( const Complex &  c  )  [inline]
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines
Generated on 10 Nov 2016 for OpenStructure by  doxygen 1.6.1