OutFile

#include <OutFile.h>

Inheritance diagram for OutFile:

Collaboration diagram for OutFile:

Classes
class	ProductStuff

Public Types
enum	ColorType { Grayscale, ColorIndex, RGB }
enum	ScaleType { Linear, Log, ArcTan }
enum	DataStorage {   ByteDS, UByteDS, ShortDS, UShortDS,   IntDS, UIntDS, FloatDS, DoubleDS }
enum	PixValues { landPix = 254, fillPix = 255 }
enum	LatLonType { LatLonOff, LatLon1D, LatLon2D }

Public Member Functions
virtual	~OutFile ()
virtual void	setSize (int32_t width, int32_t height)
virtual int32_t	getWidth () const
virtual int32_t	getHeight () const
virtual void	setFileName (std::string fileName)
virtual std::string	getFileName ()
virtual bool	open ()=0
virtual bool	close ()=0
virtual double	getMinValue (int32_t prod=0)
virtual double	getMaxValue (int32_t prod=0)
virtual std::string	getScaleTypeString (int32_t prod=0)
virtual void	setPixel (int32_t x, double val, int32_t prod=0)
virtual void	setPixelRGB (int32_t x, float red, float green, float blue)
virtual void	setTransparency ()
virtual void	setQuality (int32_t x, uint8_t val)
virtual void	landPixel (int32_t x)
virtual void	fillPixel (int32_t x)
virtual void	missingPixel (int32_t x)
virtual void	setLatLon (double *lat, double *lon)
virtual void	writeLine ()=0
virtual bool	setPalette (const char *paletteName, bool applyMask)
virtual void	setLandRGB (const char *rgb_land_string)
virtual void	setMetaData (meta_l3bType *metaData)
virtual meta_l3bType *	getMetadata ()
virtual int32_t	addProduct (productInfo_t *productInfo)
virtual int32_t	getNumProducts ()
virtual void	setMapProjection (std::string projection)
virtual void	setNumFilledPixels (int32_t num)
virtual int32_t	getNumFilledPixels ()
virtual float	getPercentFilledPixels ()
virtual void	resetFileMinMax ()
virtual double	getFileMinVal ()
virtual double	getFileMaxVal ()
virtual void	setResolution (std::string resolutionStr)
virtual void	setResolution (double resolution)
virtual double	getResolution ()
virtual void	setQualityName (std::string qualName)
std::string	getQualityName ()
virtual void	setQualityProcessing (bool val)
virtual bool	getQualityProcessing ()
virtual void	setDeflate (int val)
virtual int	getDeflate ()
void	setFullLatLon (bool val)
void	setProj4Info (std::string projStr, double minX, double maxY)

Protected Member Functions
	OutFile ()
virtual int	addProductNonDisplay (productInfo_t *productInfo)

Protected Attributes
std::string	fileName
int32_t	width
int32_t	height
int32_t	samplesperpixel
std::string	qualityName
uint8_t *	qualityData
uint32_t	currentLine
ColorType	colorType
double	fileMinVal
double	fileMaxVal
double	resolution
int	deflate
LatLonType	fullLatLon
double *	latData
double *	lonData
uint8_t *	red
uint8_t *	green
uint8_t *	blue
uint8_t *	rgb_land
bool	transparent
meta_l3bType *	metaData
std::string	mapProjection
std::string	proj4String
double	tiepoints [6]
double	pixscale [3]
std::vector< ProductStuff * >	productStuff

Static Protected Attributes
static constexpr uint8_t	qualityUnused = 255
static constexpr double	badPixelValue = -32767.0
static constexpr double	landPixelValue = -32766.0

Detailed Description

Definition at line 44 of file OutFile.h.

Member Enumeration Documentation

ColorType

enum ColorType

Enumerator
Grayscale
ColorIndex
RGB

Definition at line 47 of file OutFile.h.

DataStorage

enum DataStorage

Enumerator
ByteDS
UByteDS
ShortDS
UShortDS
IntDS
UIntDS
FloatDS
DoubleDS

Definition at line 55 of file OutFile.h.

LatLonType

enum LatLonType

Enumerator
LatLonOff
LatLon1D
LatLon2D

Definition at line 63 of file OutFile.h.

PixValues

enum PixValues

Enumerator
landPix
fillPix

Definition at line 59 of file OutFile.h.

ScaleType

enum ScaleType

Enumerator
Linear
Log
ArcTan

Definition at line 51 of file OutFile.h.

Constructor & Destructor Documentation

OutFile()

OutFile ( )

protected

Definition at line 255 of file OutFile.cpp.

~OutFile()

~OutFile ( )

virtual

Definition at line 295 of file OutFile.cpp.

Member Function Documentation

addProduct()

int32_t addProduct ( productInfo_t *  productInfo )

virtual

Add a product for display type output files

Parameters

productInfo

info structure to copy

Returns

the index for the new product

Reimplemented in OutFile_netcdf4, and OutFile_hdf4.

Definition at line 486 of file OutFile.cpp.

addProductNonDisplay()

int32_t addProductNonDisplay ( productInfo_t *  productInfo )

protectedvirtual

Definition at line 508 of file OutFile.cpp.

close()

virtual bool close ( )

pure virtual

Implemented in OutFile_netcdf4, OutFile_hdf4, OutFile_tiff, OutFile_png_rgb, OutFile_png, OutFile_ppm_rgb, and OutFile_pgm.

fillPixel()

void fillPixel ( int32_t  x )

virtual

Reimplemented in OutFile_tiff_rgb, OutFile_png_rgb, and OutFile_ppm_rgb.

Definition at line 396 of file OutFile.cpp.

getDeflate()

virtual int getDeflate ( )

inlinevirtual

Definition at line 230 of file OutFile.h.

getFileMaxVal()

virtual double getFileMaxVal ( )

inlinevirtual

Definition at line 204 of file OutFile.h.

getFileMinVal()

virtual double getFileMinVal ( )

inlinevirtual

Definition at line 200 of file OutFile.h.

getFileName()

virtual std::string getFileName ( )

inlinevirtual

Definition at line 152 of file OutFile.h.

getHeight()

int32_t getHeight ( ) const

virtual

Definition at line 337 of file OutFile.cpp.

getMaxValue()

virtual double getMaxValue ( int32_t  prod = 0 )

inlinevirtual

Definition at line 168 of file OutFile.h.

getMetadata()

virtual meta_l3bType* getMetadata ( )

inlinevirtual

Definition at line 186 of file OutFile.h.

getMinValue()

virtual double getMinValue ( int32_t  prod = 0 )

inlinevirtual

Definition at line 165 of file OutFile.h.

getNumFilledPixels()

int32_t getNumFilledPixels ( )

virtual

Definition at line 581 of file OutFile.cpp.

getNumProducts()

virtual int32_t getNumProducts ( )

inlinevirtual

Definition at line 191 of file OutFile.h.

getPercentFilledPixels()

float getPercentFilledPixels ( )

virtual

Definition at line 588 of file OutFile.cpp.

getQualityName()

std::string getQualityName ( )

inline

Definition at line 221 of file OutFile.h.

getQualityProcessing()

bool getQualityProcessing ( )

virtual

Definition at line 627 of file OutFile.cpp.

getResolution()

virtual double getResolution ( )

inlinevirtual

Definition at line 213 of file OutFile.h.

getScaleTypeString()

std::string getScaleTypeString ( int32_t  prod = 0 )

virtual

Definition at line 309 of file OutFile.cpp.

getWidth()

int32_t getWidth ( ) const

virtual

Definition at line 333 of file OutFile.cpp.

landPixel()

void landPixel ( int32_t  x )

virtual

Reimplemented in OutFile_tiff_rgb, OutFile_png_rgb, and OutFile_ppm_rgb.

Definition at line 383 of file OutFile.cpp.

missingPixel()

void missingPixel ( int32_t  x )

virtual

Reimplemented in OutFile_tiff_rgb, OutFile_png_rgb, and OutFile_ppm_rgb.

Definition at line 409 of file OutFile.cpp.

open()

virtual bool open ( )

pure virtual

Open the output file. Make sure you have set these functions first: setSize, setScale, setPalette, setMetaData, setProductInfo, setQualityProcessing.

Parameters

fileName

Returns

true if successful.

Implemented in OutFile_netcdf4, OutFile_hdf4, OutFile_tiff, OutFile_png_rgb, OutFile_png, OutFile_ppm_rgb, OutFile_ppm, and OutFile_pgm.

resetFileMinMax()

void resetFileMinMax ( )

virtual

Definition at line 596 of file OutFile.cpp.

setDeflate()

virtual void setDeflate ( int  val )

inlinevirtual

Definition at line 227 of file OutFile.h.

setFileName()

void setFileName ( std::string  fileName )

virtual

Definition at line 341 of file OutFile.cpp.

setFullLatLon()

void setFullLatLon ( bool  val )

inline

Definition at line 233 of file OutFile.h.

setLandRGB()

void setLandRGB ( const char *  rgb_land_string )

virtual

Definition at line 468 of file OutFile.cpp.

setLatLon()

void setLatLon ( double *  lat, double *  lon  )

virtual

Definition at line 422 of file OutFile.cpp.

setMapProjection()

void setMapProjection ( std::string  projection )

virtual

Definition at line 558 of file OutFile.cpp.

setMetaData()

void setMetaData ( meta_l3bType *  metaData )

virtual

Definition at line 477 of file OutFile.cpp.

setNumFilledPixels()

void setNumFilledPixels ( int32_t  num )

virtual

Definition at line 575 of file OutFile.cpp.

setPalette()

bool setPalette ( const char *  paletteName, bool  applyMask  )

virtual

Definition at line 432 of file OutFile.cpp.

setPixel()

void setPixel ( int32_t  x, double  val, int32_t  prod = 0  )

virtual

Reimplemented in OutFile_tiff_rgb, OutFile_png_rgb, and OutFile_ppm_rgb.

Definition at line 345 of file OutFile.cpp.

setPixelRGB()

void setPixelRGB ( int32_t  x, float  red, float  green, float  blue  )

virtual

Reimplemented in OutFile_tiff_rgb, OutFile_png_rgb, and OutFile_ppm_rgb.

Definition at line 359 of file OutFile.cpp.

setProj4Info()

void setProj4Info	(	std::string	projStr,
		double	minX,
		double	maxY
	)

Definition at line 562 of file OutFile.cpp.

setQuality()

void setQuality ( int32_t  x, uint8_t  val  )

virtual

Definition at line 369 of file OutFile.cpp.

setQualityName()

virtual void setQualityName ( std::string  qualName )

inlinevirtual

Definition at line 217 of file OutFile.h.

setQualityProcessing()

void setQualityProcessing ( bool  val )

virtual

Definition at line 605 of file OutFile.cpp.

setResolution() [1/2]

virtual void setResolution ( double  resolution )

inlinevirtual

Definition at line 209 of file OutFile.h.

setResolution() [2/2]

virtual void setResolution ( std::string  resolutionStr )

virtual

setSize()

void setSize ( int32_t  width, int32_t  height  )

virtual

Reimplemented in OutFile_netcdf4, OutFile_hdf4, OutFile_tiff_rgb, OutFile_tiff_gray, OutFile_tiff_color, OutFile_png_rgb, OutFile_png, OutFile_ppm_rgb, OutFile_ppm, and OutFile_pgm.

Definition at line 318 of file OutFile.cpp.

setTransparency()

void setTransparency ( )

virtual

Definition at line 365 of file OutFile.cpp.

writeLine()

virtual void writeLine ( )

pure virtual

Implemented in OutFile_netcdf4, OutFile_hdf4, OutFile_tiff_rgb, OutFile_tiff_gray, OutFile_tiff_color, OutFile_png_rgb, OutFile_png, OutFile_ppm_rgb, OutFile_ppm, and OutFile_pgm.

Member Data Documentation

badPixelValue

constexpr double badPixelValue = -32767.0

staticconstexprprotected

Definition at line 104 of file OutFile.h.

blue

uint8_t* blue

protected

Definition at line 128 of file OutFile.h.

colorType

ColorType colorType

protected

Definition at line 115 of file OutFile.h.

currentLine

uint32_t currentLine

protected

Definition at line 113 of file OutFile.h.

deflate

int deflate

protected

Definition at line 120 of file OutFile.h.

fileMaxVal

double fileMaxVal

protected

Definition at line 118 of file OutFile.h.

fileMinVal

double fileMinVal

protected

Definition at line 117 of file OutFile.h.

fileName

std::string fileName

protected

Definition at line 107 of file OutFile.h.

fullLatLon

LatLonType fullLatLon

protected

Definition at line 122 of file OutFile.h.

green

uint8_t* green

protected

Definition at line 127 of file OutFile.h.

height

int32_t height

protected

Definition at line 109 of file OutFile.h.

landPixelValue

constexpr double landPixelValue = -32766.0

staticconstexprprotected

Definition at line 105 of file OutFile.h.

latData

double* latData

protected

Definition at line 123 of file OutFile.h.

lonData

double* lonData

protected

Definition at line 124 of file OutFile.h.

mapProjection

std::string mapProjection

protected

Definition at line 133 of file OutFile.h.

metaData

meta_l3bType* metaData

protected

Definition at line 132 of file OutFile.h.

pixscale

double pixscale[3]

protected

Definition at line 137 of file OutFile.h.

productStuff

std::vector<ProductStuff*> productStuff

protected

Definition at line 139 of file OutFile.h.

proj4String

std::string proj4String

protected

Definition at line 135 of file OutFile.h.

qualityData

uint8_t* qualityData

protected

Definition at line 112 of file OutFile.h.

qualityName

std::string qualityName

protected

Definition at line 111 of file OutFile.h.

qualityUnused

constexpr uint8_t qualityUnused = 255

staticconstexprprotected

Definition at line 103 of file OutFile.h.

red

uint8_t* red

protected

Definition at line 126 of file OutFile.h.

resolution

double resolution

protected

Definition at line 119 of file OutFile.h.

rgb_land

uint8_t* rgb_land

protected

Definition at line 129 of file OutFile.h.

samplesperpixel

int32_t samplesperpixel

protected

Definition at line 110 of file OutFile.h.

tiepoints

double tiepoints[6]

protected

Definition at line 136 of file OutFile.h.

transparent

bool transparent

protected

Definition at line 130 of file OutFile.h.

width

int32_t width

protected

Definition at line 108 of file OutFile.h.

---

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

• /gfs-oceanweb/web/ocssw/ocssw_src/src/l3mapgen/OutFile.h
• /gfs-oceanweb/web/ocssw/ocssw_src/src/l3mapgen/OutFile.cpp