ost::img Namespace Reference

Namespaces
	alg
	detail
	gui
	image_state
	physics
	util

Data Structures
class	CircleMask
class	OpBase
class	AndOp
class	OrOp
class	XorOp
class	CompositeMask
class	ConstData
class	Data
class	AlgorithmBase
class	NonModAlgorithm
class	ModIPAlgorithm
class	ConstModIPAlgorithm
class	ModOPAlgorithm
class	ConstModOPAlgorithm
class	InvalidObserver
class	DataObserver
struct	InvalidExtentException
class	Extent
class	ExtentIterator
class	ExtentMask
class	InvalidImageHandle
class	ImageHandle
class	ConstImageHandle
class	ImageList
class	InvertedMask
class	MaskBase
class	MaskVisitor
class	NormalizeFnc
class	NormalizerImpl
class	NoOpNormalizer
class	RangeHandler
class	NullData
class	Observable
class	Peak
class	Phase
class	InvalidSampling
class	PixelSampling
class	Point
class	PointList
class	PolygonMask
class	Progress
class	RasterImage
class	Size
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)
DLLEXPORT_OST_IMG_BASE PeakList	ImportPeakList (const String &filename)
DLLEXPORT_OST_IMG_BASE void	ExportPeakList (const PeakList &l, const String &filename)
DLLEXPORT_OST_IMG_BASE std::ostream &	operator<< (std::ostream &, const Phase a)
DLLEXPORT_OST_IMG_BASE std::ostream &	operator<< (std::ostream &os, const Point &p)
DLLEXPORT_OST_IMG_BASE Size	operator+ (const Size &s1, const Size &s2)
DLLEXPORT_OST_IMG_BASE Size	operator- (const Size &s1, const Size &s2)
DLLEXPORT_OST_IMG_BASE std::ostream &	operator<< (std::ostream &os, const Size &s)
template<typename T >
DLLEXPORT_OST_IMG_BASE T	Random ()
template<>
Complex	Random< Complex > ()
template<>
Word	Random< Word > ()
template<typename T >
T	Random ()
UniformIntGenerator	GetUniformIntGenerator (int min, int max)
template<typename V , typename R >
DLLEXPORT_OST_IMG_BASE R	Val2Val (const V &v)
template<>
Real	Val2Val< Complex, Real > (const Complex &c)
template<>
Word	Val2Val< Complex, Word > (const Complex &c)
template<typename V , typename R >
R	Val2Val (const V &v)
template<typename T >
DLLEXPORT_OST_IMG_BASE DataType	Val2Type ()
template<>
DataType	Val2Type< Complex > ()
template<>
DataType	Val2Type< Real > ()
template<>
DataType	Val2Type< Word > ()
template<typename T >
DLLEXPORT_OST_IMG_BASE 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

ImageImpl

typedef boost::shared_ptr<ImageStateBasePtr> ImageImpl

Definition at line 41 of file image_impl.hh.

MapHandle

MapHandle = ImageHandle

Definition at line 26 of file map.hh.

MaskPtr

typedef boost::shared_ptr<MaskBase> MaskPtr

Definition at line 30 of file mask_base_fw.hh.

NormalizerBase

typedef ImageStateConstModIPAlgorithm<NormalizeFnc> NormalizerBase

Definition at line 66 of file normalizer_impl.hh.

NormalizerPtr

typedef boost::shared_ptr<NormalizerImpl> NormalizerPtr

Definition at line 34 of file normalizer_fw.hh.

OpPtr

typedef boost::shared_ptr<OpBase> OpPtr

Definition at line 64 of file composite_mask.hh.

PeakList

typedef std::vector<Peak> PeakList

Definition at line 46 of file peak.hh.

UniformIntGenerator

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

Definition at line 72 of file value_util.hh.

Enumeration Type Documentation

DataDomain

enum DataDomain

underlying data type

Enumerator
SPATIAL
FREQUENCY
HALF_FREQUENCY
DEFAULTDOMAIN

Definition at line 42 of file data_types.hh.

DataType

enum DataType

Enumerator
REAL
COMPLEX
WORD
DEFAULTTYPE

Definition at line 37 of file data_types.hh.

DivZeroMethod

enum DivZeroMethod

data domain

Enumerator
SET_ZERO
DIV_EPS
INTERPOLATE

Definition at line 51 of file data_types.hh.

DomainToColorMode

enum DomainToColorMode

Enumerator
MODULUS
PHASECOLOR

Definition at line 56 of file data_types.hh.

Function Documentation

CreateImage() [1/5]

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 ).

CreateImage() [2/5]

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

CreateImage() [3/5]

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

CreateImage() [4/5]

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

CreateImage() [5/5]

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

convenience variants to create images

CreateImageImpl()

ImageImpl ost::img::CreateImageImpl	(	const Extent &	,
		DataType	type,
		DataDomain	dom
	)

CreateMap() [1/4]

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

CreateMap() [2/4]

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

CreateMap() [3/4]

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

CreateMap() [4/4]

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

ExportPeakList()

DLLEXPORT_OST_IMG_BASE void ost::img::ExportPeakList	(	const PeakList &	l,
		const String &	filename
	)

GenerateImage() [1/2]

ImageHandle DLLEXPORT_OST_IMG_BASE ost::img::GenerateImage

(

const Data &

d

)

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

GenerateImage() [2/2]

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

GetUniformIntGenerator()

UniformIntGenerator ost::img::GetUniformIntGenerator ( int  min, int  max  )

inline

Definition at line 75 of file value_util.hh.

HasOverlap()

DLLEXPORT_OST_IMG_BASE bool ost::img::HasOverlap	(	const Extent &	e1,
		const Extent &	e2
	)

ImportPeakList()

DLLEXPORT_OST_IMG_BASE PeakList ost::img::ImportPeakList

(

const String &

filename

)

InfoToMask()

MaskPtr DLLEXPORT ost::img::InfoToMask

(

const info::InfoGroup &

g

)

Mask() [1/4]

MaskPtr DLLEXPORT_OST_IMG_BASE ost::img::Mask

(

const Circle2 &

c

)

Mask() [2/4]

MaskPtr DLLEXPORT_OST_IMG_BASE ost::img::Mask

(

const Extent &

e

)

Mask() [3/4]

MaskPtr DLLEXPORT_OST_IMG_BASE ost::img::Mask

(

const Polygon2 &

p

)

Mask() [4/4]

MaskPtr DLLEXPORT_OST_IMG_BASE ost::img::Mask

(

const Sphere &

s

)

MaskToInfo()

void DLLEXPORT ost::img::MaskToInfo	(	const MaskPtr &	mptr,
		info::InfoGroup &	g
	)

operator!=()

DLLEXPORT_OST_IMG_BASE bool ost::img::operator!=	(	const ImageHandle &	lhs,
		const ConstImageHandle &	rhs
	)

operator&()

DLLEXPORT_OST_IMG_BASE MaskPtr ost::img::operator&	(	const MaskPtr &	lhs,
		const MaskPtr &	rhs
	)

operator*() [1/5]

DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator*	(	const Complex &	v,
		const ConstImageHandle &	h
	)

operator*() [2/5]

DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator*	(	const ConstImageHandle &	h,
		const Complex &	v
	)

operator*() [3/5]

DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator*	(	const ConstImageHandle &	h,
		Real	v
	)

operator*() [4/5]

DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator*	(	const ConstImageHandle &	h1,
		const ConstImageHandle &	h2
	)

operator*() [5/5]

DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator*	(	Real	v,
		const ConstImageHandle &	h
	)

operator+() [1/6]

DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator+	(	const Complex &	v,
		const ConstImageHandle &	h
	)

operator+() [2/6]

DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator+	(	const ConstImageHandle &	h,
		const Complex &	v
	)

operator+() [3/6]

DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator+	(	const ConstImageHandle &	h,
		Real	v
	)

operator+() [4/6]

DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator+	(	const ConstImageHandle &	h1,
		const ConstImageHandle &	h2
	)

operator+() [5/6]

DLLEXPORT_OST_IMG_BASE Size ost::img::operator+	(	const Size &	s1,
		const Size &	s2
	)

operator+() [6/6]

DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator+	(	Real	v,
		const ConstImageHandle &	h
	)

operator-() [1/6]

DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator-	(	const Complex &	v,
		const ConstImageHandle &	h
	)

operator-() [2/6]

DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator-	(	const ConstImageHandle &	h,
		const Complex &	v
	)

operator-() [3/6]

DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator-	(	const ConstImageHandle &	h,
		Real	v
	)

operator-() [4/6]

DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator-	(	const ConstImageHandle &	h1,
		const ConstImageHandle &	h2
	)

operator-() [5/6]

DLLEXPORT_OST_IMG_BASE Size ost::img::operator-	(	const Size &	s1,
		const Size &	s2
	)

operator-() [6/6]

DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator-	(	Real	v,
		const ConstImageHandle &	h
	)

operator/() [1/3]

DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator/	(	const ConstImageHandle &	h,
		const Complex &	v
	)

operator/() [2/3]

DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator/	(	const ConstImageHandle &	h,
		Real	v
	)

operator/() [3/3]

DLLEXPORT_OST_IMG_BASE ImageHandle ost::img::operator/	(	const ConstImageHandle &	h1,
		const ConstImageHandle &	h2
	)

operator<<() [1/4]

DLLEXPORT_OST_IMG_BASE std::ostream& ost::img::operator<<	(	std::ostream &	,
		const Phase	a
	)

operator<<() [2/4]

DLLEXPORT_OST_IMG_BASE std::ostream& ost::img::operator<<	(	std::ostream &	os,
		const img::Extent &	b
	)

operator<<() [3/4]

DLLEXPORT_OST_IMG_BASE std::ostream& ost::img::operator<<	(	std::ostream &	os,
		const Point &	p
	)

operator<<() [4/4]

DLLEXPORT_OST_IMG_BASE std::ostream& ost::img::operator<<	(	std::ostream &	os,
		const Size &	s
	)

operator==()

DLLEXPORT_OST_IMG_BASE bool ost::img::operator==	(	const ImageHandle &	lhs,
		const ConstImageHandle &	rhs
	)

operator^()

DLLEXPORT_OST_IMG_BASE MaskPtr ost::img::operator^	(	const MaskPtr &	lhs,
		const MaskPtr &	rhs
	)

operator|()

DLLEXPORT_OST_IMG_BASE MaskPtr ost::img::operator|	(	const MaskPtr &	lhs,
		const MaskPtr &	rhs
	)

operator~()

DLLEXPORT_OST_IMG_BASE MaskPtr ost::img::operator~

(

const MaskPtr &

mptr

)

Overlap()

DLLEXPORT_OST_IMG_BASE Extent ost::img::Overlap	(	const Extent &	e1,
		const Extent &	e2
	)

Random() [1/2]

DLLEXPORT_OST_IMG_BASE T ost::img::Random ( )

inline

Definition at line 68 of file value_util.hh.

Random() [2/2]

T ost::img::Random ( )

inline

Definition at line 68 of file value_util.hh.

Random< Complex >()

Complex ost::img::Random< Complex > ( )

inline

Definition at line 51 of file value_util.hh.

Random< Word >()

Word ost::img::Random< Word > ( )

inline

Definition at line 59 of file value_util.hh.

Val2String()

DLLEXPORT_OST_IMG_BASE String ost::img::Val2String

(

)

Val2String< Complex >()

String ost::img::Val2String< Complex > ( )

inline

Definition at line 124 of file value_util.hh.

Val2String< Real >()

String ost::img::Val2String< Real > ( )

inline

Definition at line 128 of file value_util.hh.

Val2String< Word >()

String ost::img::Val2String< Word > ( )

inline

Definition at line 132 of file value_util.hh.

Val2Type()

DLLEXPORT_OST_IMG_BASE DataType ost::img::Val2Type

(

)

Val2Type< Complex >()

DataType ost::img::Val2Type< Complex > ( )

inline

Definition at line 108 of file value_util.hh.

Val2Type< Real >()

DataType ost::img::Val2Type< Real > ( )

inline

Definition at line 112 of file value_util.hh.

Val2Type< Word >()

DataType ost::img::Val2Type< Word > ( )

inline

Definition at line 116 of file value_util.hh.

Val2Val() [1/2]

DLLEXPORT_OST_IMG_BASE R ost::img::Val2Val ( const V &  v )

inline

Definition at line 100 of file value_util.hh.

Val2Val() [2/2]

R ost::img::Val2Val ( const V &  v )

inline

Definition at line 100 of file value_util.hh.

Val2Val< Complex, Real >()

Real ost::img::Val2Val< Complex, Real > ( const Complex &  c )

inline

Definition at line 91 of file value_util.hh.

Val2Val< Complex, Word >()

Word ost::img::Val2Val< Complex, Word > ( const Complex &  c )

inline

Definition at line 95 of file value_util.hh.