SatDump 2.0.0-alpha-76a915210
Loading...
Searching...
No Matches
meta.h File Reference

Image Metadata manipulation. More...

#include "image.h"
#include "nlohmann/json.hpp"

Go to the source code of this file.

Classes

struct  satdump::image::ImgCalibHandler
 Image Calibration Handler. This handles converting between raw pixel values and calibrated/physical units. It is a simple linear transform. More...

Functions

bool satdump::image::has_metadata (Image &img)
 Check if an image has metadata.
void satdump::image::set_metadata (Image &img, nlohmann::json metadata)
 Set an image's metadata.
nlohmann::json satdump::image::get_metadata (const Image &img)
 Get an image's metadata.
void satdump::image::free_metadata (const Image &img)
 Delete the image's metadata.
bool satdump::image::has_metadata_proj_cfg (Image &img)
 Check if an image has a projection.
void satdump::image::set_metadata_proj_cfg (Image &img, nlohmann::json proj_cfg)
 Set an image's projection metadata.
nlohmann::json satdump::image::get_metadata_proj_cfg (const Image &img)
 Get an image's projection.
bool satdump::image::has_metadata_calib_cfg (Image &img)
 Check if an image has a calibration config.
void satdump::image::set_metadata_calib_cfg (Image &img, nlohmann::json calib_cfg)
 Set an image's calibration metadata.
nlohmann::json satdump::image::get_metadata_calib_cfg (const Image &img)
 Get an image's calibration.

Detailed Description

Image Metadata manipulation.

Function Documentation

◆ free_metadata()

void satdump::image::free_metadata ( const Image & img)

Delete the image's metadata.

Parameters
imgthe image

◆ get_metadata()

nlohmann::json satdump::image::get_metadata ( const Image & img)

Get an image's metadata.

Parameters
imgthe image
Returns
metadata as JSON object

◆ get_metadata_calib_cfg()

nlohmann::json satdump::image::get_metadata_calib_cfg ( const Image & img)

Get an image's calibration.

Parameters
imgthe image
Returns
the calibration as JSON

◆ get_metadata_proj_cfg()

nlohmann::json satdump::image::get_metadata_proj_cfg ( const Image & img)

Get an image's projection.

Parameters
imgthe image
Returns
the projection as JSON

◆ has_metadata()

bool satdump::image::has_metadata ( Image & img)

Check if an image has metadata.

Parameters
imgthe image
Returns
true if the image has metadata

◆ has_metadata_calib_cfg()

bool satdump::image::has_metadata_calib_cfg ( Image & img)

Check if an image has a calibration config.

Parameters
imgthe image
Returns
true if the image has calibration

◆ has_metadata_proj_cfg()

bool satdump::image::has_metadata_proj_cfg ( Image & img)

Check if an image has a projection.

Parameters
imgthe image
Returns
true if the image has a projection

◆ set_metadata()

void satdump::image::set_metadata ( Image & img,
nlohmann::json metadata )

Set an image's metadata.

Parameters
imgthe image
metadatato set as JSON object

◆ set_metadata_calib_cfg()

void satdump::image::set_metadata_calib_cfg ( Image & img,
nlohmann::json calib_cfg )

Set an image's calibration metadata.

Parameters
imgthe image
proj_cfgcalibration to set

◆ set_metadata_proj_cfg()

void satdump::image::set_metadata_proj_cfg ( Image & img,
nlohmann::json proj_cfg )

Set an image's projection metadata.

Parameters
imgthe image
proj_cfgProjection to set