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
MergeImage Class Reference

#include <MergeImage.h>

Inheritance diagram for MergeImage:
Inheritance graph
Collaboration diagram for MergeImage:
Collaboration graph

Public Member Functions

virtual int getline (uint8_t *buffer, int line)
virtual int getline (uint16_t *buffer, int line)
virtual int getline (float *buffer, int line)
std::vector< Image * > * getImages ()
 Return the array of source images.
ImagegetMask (int i)
 Return the mask of source images with indice i.
virtual ~MergeImage ()
 Default destructor.
void print ()
 Merged 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.
ImagegetMask ()
 Return the associated mask.
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

 MergeImage (std::vector< Image * > &images, int channels, int *bg, int *transparent, Merge::eMergeType composition=Merge::NORMAL)
 Create an MergeImage 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 tBuf >
int _getline (tBuf *buffer, int line)

Private Attributes

std::vector< Image * > images
 Source images, similar, to make the merged image.
Merge::eMergeType composition
 Way to merge images.
int * bgValue
 Background value.
int * transparentValue
 Transparent value.

Friends

class MergeImageFactory

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

MergeImage::MergeImage ( std::vector< Image * > &  images,
int  channels,
int *  bg,
int *  transparent,
Merge::eMergeType  composition = Merge::NORMAL 
)
inlineprotected

Create an MergeImage object, from all attributes.

Parameters
[in]imagessource images
[in]channelnumber of samples per output pixel
[in]bgValuepixel's value to use as background, one integer per output sample
[in]transparentValuepixel's value to consider as transparent, 3 integers
[in]compositionmerge method to use

Member Function Documentation

std::vector<Image*>* MergeImage::getImages ( )
inline

Return the array of source images.

Returns
source images
Image* MergeImage::getMask ( int  i)
inline

Return the mask of source images with indice i.

Parameters
[in]isource image indice, whose mask is wanted
Returns
mask

Member Data Documentation

std::vector<Image*> MergeImage::images
private

Source images, similar, to make the merged image.

First image is the bottom one


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