GridBmp Class Reference

#include <GridBmp.hpp>

Inheritance diagram for GridBmp:

Public Member Functions
	GridBmp (const char *filename, const Db *db=nullptr)
	GridBmp (const GridBmp &r)
GridBmp &	operator= (const GridBmp &r)
virtual	~GridBmp ()
bool	mustBeGrid () const override
bool	mustBeOneVariable () const override
bool	mustBeForNDim (int ndim) const override
bool	mustBeForRotation (int mode) const override
int	writeInFile () override
DbGrid *	readGridFromFile () override
void	setColors (const VectorInt &reds, const VectorInt &greens, const VectorInt &blues)
void	setFFFF (int red, int green, int blue)
void	setHigh (int red, int green, int blue)
void	setLow (int red, int green, int blue)
void	setMask (int red, int green, int blue)
void	setFlagHigh (bool flagHigh)
void	setFlagLow (bool flagLow)
void	setNcolor (int ncolor)
void	setNmult (int nmult)
void	setNsamplex (int nsamplex)
void	setNsampley (int nsampley)
void	setValmax (double valmax)
void	setValmin (double valmin)
Public Member Functions inherited from AOF
	AOF (const String &filename, const Db *db=nullptr)
	AOF (const AOF &r)
AOF &	operator= (const AOF &r)
virtual	~AOF ()
virtual bool	isAuthorized () const
virtual Db *	readFromFile ()
bool	isValidForGrid () const
bool	isValidForVariable () const
bool	isValidForNDim () const
bool	isValidForRotation () const
void	setCols (const VectorInt &cols)
void	setCols (int ncol, int *icols)
void	setCol (int icol)
const String &	getFilename () const

Private Member Functions
void	_writeOut (int mode, unsigned int ival)
int	_colorRank (int iech, int ncolor, double vmin, double vmax)
void	_colorInRGB (int rank, bool flag_color_scale, unsigned char *ired, unsigned char *igreen, unsigned char *iblue)
int	_compose (int nb)
unsigned char	_readIn ()
void	_rgb2num (int red, int green, int blue, int a, unsigned char *c)
	‍****************************************************************************‍/ *! More...

Private Attributes
int	_nsamplex
int	_nsampley
int	_nmult
int	_ncolor
bool	_flag_low
bool	_flag_high
int	_mask_red
int	_mask_green
int	_mask_blue
int	_ffff_red
int	_ffff_green
int	_ffff_blue
int	_low_red
int	_low_green
int	_low_blue
int	_high_red
int	_high_green
int	_high_blue
double	_valmin
double	_valmax
VectorInt	_reds
VectorInt	_greens
VectorInt	_blues

Additional Inherited Members
Protected Member Functions inherited from AOF
int	_fileWriteOpen ()
int	_fileReadOpen ()
void	_fileClose ()
Protected Attributes inherited from AOF
String	_filename
const Db *	_db
const DbGrid *	_dbgrid
VectorInt	_cols
FILE *	_file

Constructor & Destructor Documentation

GridBmp() [1/2]

GridBmp::GridBmp	(	const char *	filename,
		const Db *	db = nullptr
	)

GridBmp() [2/2]

GridBmp::GridBmp

(

const GridBmp &

r

)

~GridBmp()

GridBmp::~GridBmp ( )

virtual

Member Function Documentation

_colorInRGB()

void GridBmp::_colorInRGB ( int  rank, bool  flag_color_scale, unsigned char *  ired, unsigned char *  igreen, unsigned char *  iblue  )

private

Convert a color rank into the Red, Green, Blue color decomposition

Parameters

[in]	rank	Rank of the color
[in]	flag_color_scale	1 if the color scale must be used 0 use the grey scale instead
[out]	ired	Value for the red beam
[out]	igreen	Value for the green beam
[out]	iblue	Value for the blue beam

_colorRank()

int GridBmp::_colorRank ( int  iech, int  ncolor, double  vmin, double  vmax  )

private

Color rank for the sample of the Db

Returns

Color rank

COLOR_MASK : The sample is masked off

COLOR_FFFF : The value if FFFF

COLOR_LOWER : The value if below vmin and must be acknowledged

COLOR_UPPER : The value if above vmax and must be acknowledged

Parameters

[in]	iech	Rank of the sample
[in]	ncolor	Number of colors
[in]	vmin	Minimum value to be represented
[in]	vmax	Maximum value to be represented

_compose()

int GridBmp::_compose ( int  nb )

private

Compose several bytes into an integer

Returns

Returned integer

Parameters

[in]

nb

Number of bytes to be considered

_readIn()

unsigned char GridBmp::_readIn ( )

private

Read a byte from the binary file

_rgb2num()

void GridBmp::_rgb2num ( int  red, int  green, int  blue, int  a, unsigned char *  c  )

private

‍****************************************************************************‍/ *!

Convert RGB into numeric

Parameters

[in]	red	Red index
[in]	green	Green index
[in]	blue	Blue index
[in]	a	Auxiliary parameter
[out]	c	Numeric value

_writeOut()

void GridBmp::_writeOut ( int  mode, unsigned int  ival  )

private

Print an integer

Parameters

[in]	mode	Type of writing 0 : 16-bit unsigned integer 1 : 32-bit unsigned integer 2 : 32-bit signed integer
[in]	ival	Integer value to be written

mustBeForNDim()

bool GridBmp::mustBeForNDim ( int  ndim ) const

inlineoverridevirtual

Reimplemented from AOF.

mustBeForRotation()

bool GridBmp::mustBeForRotation ( int  mode ) const

inlineoverridevirtual

Reimplemented from AOF.

mustBeGrid()

bool GridBmp::mustBeGrid ( ) const

inlineoverridevirtual

Reimplemented from AOF.

mustBeOneVariable()

bool GridBmp::mustBeOneVariable ( ) const

inlineoverridevirtual

Reimplemented from AOF.

operator=()

GridBmp & GridBmp::operator=

(

const GridBmp &

r

)

readGridFromFile()

DbGrid * GridBmp::readGridFromFile ( )

overridevirtual

Reimplemented from AOF.

setColors()

void GridBmp::setColors	(	const VectorInt &	reds,
		const VectorInt &	greens,
		const VectorInt &	blues
	)

setFFFF()

void GridBmp::setFFFF	(	int	red,
		int	green,
		int	blue
	)

setFlagHigh()

void GridBmp::setFlagHigh ( bool  flagHigh )

inline

setFlagLow()

void GridBmp::setFlagLow ( bool  flagLow )

inline

setHigh()

void GridBmp::setHigh	(	int	red,
		int	green,
		int	blue
	)

setLow()

void GridBmp::setLow	(	int	red,
		int	green,
		int	blue
	)

setMask()

void GridBmp::setMask	(	int	red,
		int	green,
		int	blue
	)

setNcolor()

void GridBmp::setNcolor ( int  ncolor )

inline

setNmult()

void GridBmp::setNmult ( int  nmult )

inline

setNsamplex()

void GridBmp::setNsamplex ( int  nsamplex )

inline

setNsampley()

void GridBmp::setNsampley ( int  nsampley )

inline

setValmax()

void GridBmp::setValmax ( double  valmax )

inline

setValmin()

void GridBmp::setValmin ( double  valmin )

inline

writeInFile()

int GridBmp::writeInFile ( )

overridevirtual

Reimplemented from AOF.

Member Data Documentation

_blues

VectorInt GridBmp::_blues

private

_ffff_blue

int GridBmp::_ffff_blue

private

_ffff_green

int GridBmp::_ffff_green

private

_ffff_red

int GridBmp::_ffff_red

private

_flag_high

bool GridBmp::_flag_high

private

_flag_low

bool GridBmp::_flag_low

private

_greens

VectorInt GridBmp::_greens

private

_high_blue

int GridBmp::_high_blue

private

_high_green

int GridBmp::_high_green

private

_high_red

int GridBmp::_high_red

private

_low_blue

int GridBmp::_low_blue

private

_low_green

int GridBmp::_low_green

private

_low_red

int GridBmp::_low_red

private

_mask_blue

int GridBmp::_mask_blue

private

_mask_green

int GridBmp::_mask_green

private

_mask_red

int GridBmp::_mask_red

private

_ncolor

int GridBmp::_ncolor

private

_nmult

int GridBmp::_nmult

private

_nsamplex

int GridBmp::_nsamplex

private

_nsampley

int GridBmp::_nsampley

private

_reds

VectorInt GridBmp::_reds

private

_valmax

double GridBmp::_valmax

private

_valmin

double GridBmp::_valmin

private

---

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

• include/OutputFormat/GridBmp.hpp
• src/OutputFormat/GridBmp.cpp