class P1::ImageSdk::Jp2Writer

Overview

#include <P1ImageJp2Writer.hpp>

class Jp2Writer
{
public:
    // construction

    Jp2Writer(
        std::string filename,
        P1::ImageSdk::BitmapImage& bitmap,
        P1::ImageSdk::RawImage& image,
        Jp2Config& config
        );

    Jp2Writer(
        std::string filename,
        P1::ImageSdk::BitmapImage& bitmap,
        P1::ImageSdk::RawImage& image,
        P1::ImageSdkC::P1MetaDataBase& metadata,
        Jp2Config& config
        );
};

Detailed Documentation

Construction

Jp2Writer(
    std::string filename,
    P1::ImageSdk::BitmapImage& bitmap,
    P1::ImageSdk::RawImage& image,
    Jp2Config& config
    )

Writes a JPEG 2000 file to the disk synchronously.

Parameters:

filename

The path to the output file, it may be a single character string.

bitmap

The rendered bitmap

image

The raw image’s in memory representation

config

Describes the JPEG 2000 metadata/preview

SDKException

The function will throw an exception in case of failure.

Jp2Writer(
    std::string filename,
    P1::ImageSdk::BitmapImage& bitmap,
    P1::ImageSdk::RawImage& image,
    P1::ImageSdkC::P1MetaDataBase& metadata,
    Jp2Config& config
    )

Writes a JPEG 2000 file to the disk synchronously.

Parameters:

filename

The path to the output file, it may be a single character string.

bitmap

The rendered bitmap

image

The raw image’s in memory representation

metadata

The metadatabase to writen into the image file.

config

Describes the JPEG 2000 metadata/preview

SDKException

The function will throw an exception in case of failure.