satdump::xrit::SegmentedImageDecoder Class Reference

Abstract Segmented decoder implementation to be overriden for mission-specific decoders. More...

#include <segment_decoder.h>

Inheritance diagram for satdump::xrit::SegmentedImageDecoder:

Public Member Functions
virtual void	pushSegment (XRITFile &file)=0
	Push a segment into the work-in-progress image. These should already be filtered using file_info.seg_groupid.
virtual bool	isComplete ()=0
	Allows knowing if an image is complete, to save it instantly.
virtual void	reset ()=0
	Resets the decoder, to lower RAM usage.
virtual bool	hasData ()=0
	Allows knowing if an image has data at all (and hence, worth saving)

Public Attributes
image::Image	image
XRITFileInfo	info

Detailed Description

Abstract Segmented decoder implementation to be overriden for mission-specific decoders.

Parameters

image	WIP image
info	xRIT File Info, to be set by the user on creating an instance of this class, and used when saving the final image.

Member Function Documentation

hasData()

virtual bool satdump::xrit::SegmentedImageDecoder::hasData ( )

pure virtual

Allows knowing if an image has data at all (and hence, worth saving)

Returns

true if at least 1 segment is present

Implemented in satdump::xrit::FY4xSegmentedImageDecoder, satdump::xrit::GK2ASegmentedImageDecoder, satdump::xrit::GOESSegmentedImageDecoder, satdump::xrit::HimawariSegmentedImageDecoder, and satdump::xrit::MSGSegmentedImageDecoder.

isComplete()

virtual bool satdump::xrit::SegmentedImageDecoder::isComplete ( )

pure virtual

Allows knowing if an image is complete, to save it instantly.

Returns

true if complete

Implemented in satdump::xrit::FY4xSegmentedImageDecoder, satdump::xrit::GK2ASegmentedImageDecoder, satdump::xrit::GOESSegmentedImageDecoder, satdump::xrit::HimawariSegmentedImageDecoder, and satdump::xrit::MSGSegmentedImageDecoder.

pushSegment()

virtual void satdump::xrit::SegmentedImageDecoder::pushSegment ( XRITFile & file )

pure virtual

Push a segment into the work-in-progress image. These should already be filtered using file_info.seg_groupid.

Parameters

file	segment to push

Implemented in satdump::xrit::FY4xSegmentedImageDecoder, satdump::xrit::GK2ASegmentedImageDecoder, satdump::xrit::GOESSegmentedImageDecoder, satdump::xrit::HimawariSegmentedImageDecoder, and satdump::xrit::MSGSegmentedImageDecoder.

reset()

virtual void satdump::xrit::SegmentedImageDecoder::reset ( )

pure virtual

Resets the decoder, to lower RAM usage.

Implemented in satdump::xrit::FY4xSegmentedImageDecoder, satdump::xrit::GK2ASegmentedImageDecoder, satdump::xrit::GOESSegmentedImageDecoder, satdump::xrit::HimawariSegmentedImageDecoder, and satdump::xrit::MSGSegmentedImageDecoder.

---

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

• plugins/xrit_support/xrit/segment_decoder.h