#include <NeighImage.hpp>

Inheritance diagram for NeighImage:

Public Member Functions
	NeighImage (const VectorInt &radius=VectorInt(), int skip=0, const ASpace *space=nullptr)

	NeighImage (const NeighImage &r)

NeighImage &	operator= (const NeighImage &r)

virtual	~NeighImage ()

virtual String	toString (const AStringFormat *strfmt=nullptr) const override
	AStringable interface. More...

virtual int	getMaxSampleNumber (const Db *db) const override

virtual ENeigh	getType () const override

int	getSkip () const

const VectorInt &	getImageRadius () const

int	getImageRadius (int idim) const

void	setImageRadius (const VectorInt &imageRadius)

void	setSkip (int skip)

Public Member Functions inherited from ANeighParam
	ANeighParam (bool flag_xvalid=false, const ASpace *space=nullptr)

	ANeighParam (const ANeighParam &r)

ANeighParam &	operator= (const ANeighParam &r)

virtual	~ANeighParam ()

virtual bool	isConsistent (const ASpace *space) const override
	ASpaceObject Interface. More...

virtual bool	getFlagContinuous () const

bool	getFlagXvalid () const

bool	getFlagKFold () const

void	setFlagXvalid (bool flagXvalid)

void	setFlagKFold (bool flagKFold)

VectorInt	eval (Db dbin, Db dbout, int iech0) const

Public Member Functions inherited from ASpaceObject
	ASpaceObject (const ASpace *space=nullptr)

	ASpaceObject (const ASpace &space)

	ASpaceObject (const ASpaceObject &r)

ASpaceObject &	operator= (const ASpaceObject &r)

virtual	~ASpaceObject ()

const ASpace *	getSpace () const
	Accessor to the current object space context. More...

bool	isConsistent () const
	Indicate if I am consistent with my current space context. More...

VectorDouble	getUnitaryVector () const
	Return unitary vector for the current space context. More...

unsigned int	getNDim () const
	Shortcuts to ASpace methods. More...

const VectorDouble &	getOrigin () const
	Return the current space context origin coordinates. More...

double	getDistance (const SpacePoint &p1, const SpacePoint &p2) const
	Return the distance between two space points for the current space context. More...

VectorDouble	getIncrement (const SpacePoint &p1, const SpacePoint &p2) const
	Return the increment vector between two space points for the current space context. More...

Public Member Functions inherited from AStringable
	AStringable ()

	AStringable (const AStringable &r)

AStringable &	operator= (const AStringable &r)

virtual	~AStringable ()

virtual void	display (const AStringFormat *strfmt=nullptr) const final

virtual void	display (int level) const final

Public Member Functions inherited from ASerializable
	ASerializable ()

	ASerializable (const ASerializable &r)

ASerializable &	operator= (const ASerializable &r)

virtual	~ASerializable ()

bool	deserialize (std::istream &is, bool verbose=true)

bool	serialize (std::ostream &os, bool verbose=true) const

bool	dumpToNF (const String &neutralFilename, bool verbose=false) const

Static Public Member Functions
static NeighImage *	create (const VectorInt &image, int skip=0, const ASpace *space=nullptr)

static NeighImage *	createFromNF (const String &neutralFilename, bool verbose=true)

Static Public Member Functions inherited from ASerializable
static String	buildFileName (const String &filename, bool ensureDirExist=false)

static String	getHomeDirectory (const String &sub="")

static String	getWorkingDirectory ()

static String	getTestData (const String &subdir, const String &filename)

static String	getFileIdentity (const String &filename, bool verbose=false)

static void	setContainerName (bool useDefault, const String &containerName=String(), bool verbose=false)

static void	unsetContainerName ()

static void	setPrefixName (const String &prefixName)

static void	unsetPrefixName ()

static const String &	getContainerName ()

static const String &	getPrefixName ()

static bool	createDirectory (const String &dir)

static String	getExecDirectory ()

static String	getDirectory (const String &path)

Protected Member Functions
virtual bool	_deserialize (std::istream &is, bool verbose=false) override
	Interface for ASerializable. More...

virtual bool	_serialize (std::ostream &os, bool verbose=false) const override

String	_getNFName () const override

Protected Member Functions inherited from ASpaceObject
void	setNDim (int ndim)
	Modify the Space dimension of an already created item (To be used only during creation ... in particular when reading NF) More...

Protected Member Functions inherited from ASerializable
bool	_fileOpenWrite (const String &filename, std::ofstream &os, bool verbose=false) const

bool	_fileOpenRead (const String &filename, std::ifstream &is, bool verbose=false) const

Private Attributes
int	_skip

VectorInt	_imageRadius

Additional Inherited Members
Static Protected Member Functions inherited from ASerializable
static bool	_commentWrite (std::ostream &os, const String &comment)

template<typename T >
static bool	_recordWrite (std::ostream &os, const String &title, const T &val)

template<typename T >
static bool	_recordWriteVec (std::ostream &os, const String &title, const VectorT< T > &vec)

template<typename T >
static bool	_recordRead (std::istream &is, const String &title, T &val)

template<typename T >
static bool	_recordReadVec (std::istream &is, const String &title, VectorT< T > &vec, int nvalues)

static bool	_onlyBlanks (char *string)

static bool	_tableRead (std::istream &is, const String &string, int ntab, double *tab)

static bool	_tableWrite (std::ostream &os, const String &string, int ntab, const VectorDouble &tab)

Protected Attributes inherited from ASpaceObject
const ASpace *	_space
	Current space context of the object. More...

Constructor & Destructor Documentation

◆ NeighImage() [1/2]

NeighImage::NeighImage	(	const VectorInt &	radius = `VectorInt()`,
		int	skip = `0`,
		const ASpace *	space = `nullptr`
	)

◆ NeighImage() [2/2]

NeighImage::NeighImage ( const NeighImage & r )

◆ ~NeighImage()

NeighImage::~NeighImage ( )

virtual

Member Function Documentation

◆ _deserialize()

bool NeighImage::_deserialize	(	std::istream &	is,
		bool	verbose = `false`
	)

overrideprotectedvirtual

Interface for ASerializable.

Reimplemented from ANeighParam.

◆ _getNFName()

String NeighImage::_getNFName ( ) const

inlineoverrideprotectedvirtual

Reimplemented from ANeighParam.

◆ _serialize()

bool NeighImage::_serialize	(	std::ostream &	os,
		bool	verbose = `false`
	)		const

overrideprotectedvirtual

Reimplemented from ANeighParam.

◆ create()

NeighImage * NeighImage::create	(	const VectorInt &	image,
		int	skip = `0`,
		const ASpace *	space = `nullptr`
	)

static

◆ createFromNF()

NeighImage * NeighImage::createFromNF	(	const String &	neutralFilename,
		bool	verbose = `true`
	)

static

Create a NeighImageborhood by loading the contents of a Neutral File

Parameters

neutralFilename	Name of the Neutral File
verbose	Verbose flag

Returns

◆ getImageRadius() [1/2]

const VectorInt& NeighImage::getImageRadius ( ) const

inline

◆ getImageRadius() [2/2]

int NeighImage::getImageRadius ( int idim ) const

inline

◆ getMaxSampleNumber()

int NeighImage::getMaxSampleNumber ( const Db * db ) const

overridevirtual

Given a Db, returns the maximum number of samples per NeighImageborhood

Parameters

db	Pointer to the taregt Db

Returns

Implements ANeighParam.

◆ getSkip()

int NeighImage::getSkip ( ) const

inline

◆ getType()

virtual ENeigh NeighImage::getType ( ) const

inlineoverridevirtual

Implements ANeighParam.

◆ operator=()

NeighImage & NeighImage::operator= ( const NeighImage & r )

◆ setImageRadius()

void NeighImage::setImageRadius ( const VectorInt & imageRadius )

inline

◆ setSkip()

void NeighImage::setSkip ( int skip )

inline

◆ toString()

String NeighImage::toString ( const AStringFormat * strfmt = nullptr ) const

overridevirtual

AStringable interface.

Reimplemented from ANeighParam.

Member Data Documentation

◆ _imageRadius

VectorInt NeighImage::_imageRadius

private

◆ _skip

int NeighImage::_skip

private

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

include/Neigh/NeighImage.hpp
src/Neigh/NeighImage.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ NeighImage() [1/2]

◆ NeighImage() [2/2]

◆ ~NeighImage()

Member Function Documentation

◆ _deserialize()

◆ _getNFName()

◆ _serialize()

◆ create()

◆ createFromNF()

◆ getImageRadius() [1/2]

◆ getImageRadius() [2/2]

◆ getMaxSampleNumber()

◆ getSkip()

◆ getType()

◆ operator=()

◆ setImageRadius()

◆ setSkip()

◆ toString()

Member Data Documentation

◆ _imageRadius

◆ _skip