libimage  0.25.4
 All Classes Namespaces Files Functions Variables Enumerations Macros Pages
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
DecimatedImage Class Reference

#include <DecimatedImage.h>

Inheritance diagram for DecimatedImage:
Inheritance graph
Collaboration diagram for DecimatedImage:
Collaboration graph

Public Member Functions

ImagegetMask ()
 Return the mask of source image.
ImagegetImage ()
 Return the source image.
int * getNodata ()
 Return the nodata value.
int getline (uint8_t *buffer, int line)
int getline (uint16_t *buffer, int line)
int getline (float *buffer, int line)
virtual ~DecimatedImage ()
 Default destructor.
void print ()
 Compounded image description output.
- Public Member Functions inherited from Image
void makeMask ()
 Define the image as a mask.
int getWidth ()
 Return the image's width.
int getHeight ()
 Return the image's height.
void setBbox (BoundingBox< double > box)
 Define the image's bounding box and calculate resolutions.
bool setDimensions (int w, int h, BoundingBox< double > box, double rx, double ry)
 Define the image's bounding box and calculate resolutions.
BoundingBox< double > getBbox () const
 Return the image's bounding box.
void setCRS (CRS srs)
 Define the CRS of the image's bounding box.
CRS getCRS () const
 Return the image's bounding box's CRS.
double getXmin () const
 Return bounding box's xmin.
double getYmax () const
 Return bounding box's ymax.
double getXmax () const
 Return bounding box's xmax.
double getYmin () const
 Return bounding box's ymin.
double getResX () const
 Return the X wise resolution.
double getResY () const
 Return the Y wise resolution.
bool setMask (Image *newMask)
 Defined data mask and check consistency.
int x2c (double x)
 Conversion from terrain coordinate X to image column indice.
int y2l (double y)
 Conversion from terrain coordinate Y to image line indice.
double c2x (int c)
 Conversion from image column indice to terrain coordinate X (pixel's center)
double l2y (int l)
 Conversion from image line indice to terrain coordinate X (pixel's center)
double getPhaseX ()
 Phasis calculation, X wise.
double getPhaseY ()
 Phasis calculation, Y wise.
bool isCompatibleWith (Image *pImage)
 Determine compatibility with another image, comparing CRS, phasis and resolutions.
 Image (int width, int height, int channels, double resx, double resy, BoundingBox< double > bbox)
 Create an Image object, from all attributes.
 Image (int width, int height, int channels)
 Create an Image without providing georeferencement, neither resolutions nor bounding box.
 Image (int width, int height, int channels, BoundingBox< double > bbox)
 Create an Image without providing resolutions.
 Image (int width, int height, int channels, double resx, double resy)
 Create an Image object without providing bbox.
virtual ~Image ()
 Default destructor.
virtual void printTFW ()
 Image TFW output.

Protected Member Functions

 DecimatedImage (int width, int height, int channels, double resx, double resy, BoundingBox< double > bbox, Image *image, int *nd)
 Create an DecimatedImage object, from all attributes.
- Protected Member Functions inherited from Image
void computeResolutions ()
 Resolutions calculation, from pixel size and bounding box.

Private Member Functions

template<typename T >
int _getline (T *buffer, int line)

Private Attributes

ImagesourceImage
 Source image, to decimate.
int * nodata
 Nodata value.
int ratioX
 Decimation's step, widthwise.
int ratioY
 Decimation's step, heightwise.
int sourceOffsetX
 First source pixel column to be in the decimated image.
int numberX
 Pixel number to read in the source image, to build decimated image.
int imageOffsetX
 First decimated pixel column to come from the source image.

Friends

class DecimatedImageFactory

Additional Inherited Members

- Static Public Member Functions inherited from Image
static bool dimensionsAreConsistent (double resolution_x, double resolution_y, int w, int h, BoundingBox< double > bounding_box)
 Check provided dimensions' consistency.
- Public Attributes inherited from Image
const int channels
 Number of samples per pixel.
- Protected Attributes inherited from Image
int width
 Image's width, in pixel.
int height
 Image's height, in pixel.
bool isMask
 Is this image a mask ?
BoundingBox< double > bbox
 Image's bounding box.
CRS crs
 Bounding box's CRS.
Imagemask
 Mask associated to the image, optionnal.
double resx
 Image's resolution, X wise.
double resy
 Image's resolution, Y wise.

Detailed Description

Author
Institut national de l'information géographique et forestière

Constructor & Destructor Documentation

DecimatedImage::DecimatedImage ( int  width,
int  height,
int  channels,
double  resx,
double  resy,
BoundingBox< double >  bbox,
Image image,
int *  nd 
)
protected

Create an DecimatedImage object, from all attributes.

Parameters
[in]widthimage width, in pixel
[in]heightimage height, in pixel
[in]channelnumber of samples per pixel
[in]resxX wise resolution
[in]resyY wise resolution
[in]bboxbounding box
[in]imagesource image
[in]ndnodata value

Here is the call graph for this function:

Member Function Documentation

Image* DecimatedImage::getImage ( )
inline

Return the source image.

Returns
image
Image* DecimatedImage::getMask ( )
inline

Return the mask of source image.

Returns
mask

Reimplemented from Image.

Here is the call graph for this function:

int* DecimatedImage::getNodata ( )
inline

Return the nodata value.

Returns
nodata value

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