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

#include <ExtendedCompoundImage.h>

Inheritance diagram for ExtendedCompoundImage:
Inheritance graph
Collaboration diagram for ExtendedCompoundImage:
Collaboration graph

Public Member Functions

std::vector< Image * > * getImages ()
 Return the array of source images.
void getOffsets (int i, int *ol, int *c0, int *c1, int *c2)
 Return asked image's offsets, for columns and lines.
bool useMasks ()
 Precise if one or more source images own a mask.
ImagegetMask (int i)
 Return the mask of source images with indice i.
ImagegetImage (int i)
 Return the source images with indice i.
bool addMirrors (int mirrorSize)
 Add mirrors to source images.
bool extendBbox (BoundingBox< double > otherbbox, int morePix)
 Modify image's dimensions.
uint getMirrorsNumber ()
 Return the mirror images' number among source images.
int * getNodata ()
 Return the nodata value.
int getline (uint8_t *buffer, int line)
int getline (float *buffer, int line)
int getline (uint16_t *buffer, int line)
virtual ~ExtendedCompoundImage ()
 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.
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

 ExtendedCompoundImage (int width, int height, int channels, double resx, double resy, BoundingBox< double > bbox, std::vector< Image * > &images, int *nd, uint mirrors)
 Create an ExtendedCompoundImage 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)
void calculateOffsets ()

Private Attributes

std::vector< Image * > sourceImages
 Source images, consistent , to make the compounded image.
std::vector< int > rowsOffsets
 Row's offset.
std::vector< int > c0s
 Columns's offset.
std::vector< int > c1s
 Columns's offset.
std::vector< int > c2s
 Columns's offset.
uint mirrorsNumber
 Mirror images' number among source images.
int * nodata
 Nodata value.

Friends

class ExtendedCompoundImageFactory

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
eci.png

Constructor & Destructor Documentation

ExtendedCompoundImage::ExtendedCompoundImage ( int  width,
int  height,
int  channels,
double  resx,
double  resy,
BoundingBox< double >  bbox,
std::vector< Image * > &  images,
int *  nd,
uint  mirrors 
)
inlineprotected

Create an ExtendedCompoundImage 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]imagessource images
[in]ndnodata value
[in]mirrorsmirror images' number in source images (put in front)

Member Function Documentation

bool ExtendedCompoundImage::addMirrors ( int  mirrorSize)

Add mirrors to source images.

miroirs.png

Here is the call graph for this function:

Image* ExtendedCompoundImage::getImage ( int  i)
inline

Return the source images with indice i.

Parameters
[in]iwanted source image indice
Returns
image
std::vector<Image*>* ExtendedCompoundImage::getImages ( )
inline

Return the array of source images.

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

Return the mask of source images with indice i.

Parameters
[in]isource image indice, whose mask is wanted
Returns
mask
uint ExtendedCompoundImage::getMirrorsNumber ( )
inline

Return the mirror images' number among source images.

Returns
mirror images' number
int* ExtendedCompoundImage::getNodata ( )
inline

Return the nodata value.

Returns
nodata value
void ExtendedCompoundImage::getOffsets ( int  i,
int *  ol,
int *  c0,
int *  c1,
int *  c2 
)
inline

Return asked image's offsets, for columns and lines.

Returns
offsets
bool ExtendedCompoundImage::useMasks ( )
inline

Precise if one or more source images own a mask.

Returns
mask presence

Here is the call graph for this function:

Member Data Documentation

std::vector<Image*> ExtendedCompoundImage::sourceImages
private

Source images, consistent , to make the compounded image.

First image is the bottom one


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