OB.DAAC Logo
NASA Logo
Ocean Color Science Software

ocssw V2022

#include <OutFile.h>

Inheritance diagram for OutFile_ppm_rgb:
[legend]
Collaboration diagram for OutFile_ppm_rgb:
[legend]

Public Member Functions

 OutFile_ppm_rgb ()
 
virtual ~OutFile_ppm_rgb ()
 
virtual void setSize (int32_t width, int32_t height)
 
virtual bool open ()
 
virtual bool close ()
 
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 landPixel (int32_t x)
 
virtual void fillPixel (int32_t x)
 
virtual void missingPixel (int32_t x)
 
virtual void writeLine ()
 
- Public Member Functions inherited from OutFile
virtual ~OutFile ()
 
virtual int32_t getWidth () const
 
virtual int32_t getHeight () const
 
virtual void setFileName (std::string fileName)
 
virtual std::string getFileName ()
 
virtual double getMinValue (int32_t prod=0)
 
virtual double getMaxValue (int32_t prod=0)
 
virtual std::string getScaleTypeString (int32_t prod=0)
 
virtual void setTransparency ()
 
virtual void setQuality (int32_t x, uint8_t val)
 
virtual void setLatLon (double *lat, double *lon)
 
virtual bool setPalette (const char *paletteName, bool applyMask)
 
virtual void setLandRGB (const char *rgb_land_string)
 
virtual void setMetaData (meta_l3bType *metaData)
 
virtual meta_l3bTypegetMetadata ()
 
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)
 

Additional Inherited Members

- Public Types inherited from OutFile
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 }
 
- Protected Member Functions inherited from OutFile
 OutFile ()
 
virtual int addProductNonDisplay (productInfo_t *productInfo)
 
- Protected Attributes inherited from OutFile
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_l3bTypemetaData
 
std::string mapProjection
 
std::string proj4String
 
double tiepoints [6]
 
double pixscale [3]
 
std::vector< ProductStuff * > productStuff
 
- Static Protected Attributes inherited from OutFile
static constexpr uint8_t qualityUnused = 255
 
static constexpr double badPixelValue = -32767.0
 
static constexpr double landPixelValue = -32766.0
 

Detailed Description

Definition at line 271 of file OutFile.h.

Constructor & Destructor Documentation

◆ OutFile_ppm_rgb()

Definition at line 728 of file OutFile.cpp.

◆ ~OutFile_ppm_rgb()

~OutFile_ppm_rgb ( )
virtual

Definition at line 734 of file OutFile.cpp.

Member Function Documentation

◆ close()

bool close ( )
virtual

Implements OutFile.

Definition at line 763 of file OutFile.cpp.

◆ fillPixel()

void fillPixel ( int32_t  x)
virtual

Reimplemented from OutFile.

Definition at line 814 of file OutFile.cpp.

◆ landPixel()

void landPixel ( int32_t  x)
virtual

Reimplemented from OutFile.

Definition at line 799 of file OutFile.cpp.

◆ missingPixel()

void missingPixel ( int32_t  x)
virtual

Reimplemented from OutFile.

Definition at line 829 of file OutFile.cpp.

◆ open()

bool open ( )
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.

Implements OutFile.

Definition at line 749 of file OutFile.cpp.

◆ setPixel()

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

Reimplemented from OutFile.

Definition at line 769 of file OutFile.cpp.

◆ setPixelRGB()

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

Reimplemented from OutFile.

Definition at line 775 of file OutFile.cpp.

◆ setSize()

void setSize ( int32_t  width,
int32_t  height 
)
virtual

Reimplemented from OutFile.

Definition at line 741 of file OutFile.cpp.

◆ writeLine()

void writeLine ( )
virtual

Implements OutFile.

Definition at line 844 of file OutFile.cpp.


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