38 #ifndef OME_FILES_DETAIL_FORMATWRITER_H 39 #define OME_FILES_DETAIL_FORMATWRITER_H 41 #include <ome/files/FormatWriter.h> 42 #include <ome/files/FormatHandler.h> 84 const std::string& description):
86 description(description),
88 compression_suffixes(),
90 pixel_compression_types(),
93 compression_suffixes.push_back(boost::filesystem::path(
""));
119 std::shared_ptr<std::ostream>
out;
164 isThisType(
const boost::filesystem::path&
name,
165 bool open =
true)
const;
177 getSeriesCount()
const;
213 setMetadataRetrieve(std::shared_ptr<::ome::xml::meta::MetadataRetrieve>& retrieve);
216 const std::shared_ptr<::ome::xml::meta::MetadataRetrieve>&
217 getMetadataRetrieve()
const;
220 std::shared_ptr<::ome::xml::meta::MetadataRetrieve>&
221 getMetadataRetrieve();
230 getImageCount()
const;
298 getPixelType()
const;
311 getBitsPerPixel()
const;
326 getEffectiveSizeC()
const;
348 getDimensionOrder()
const;
363 std::array<dimension_size_type, 3>
372 getFramesPerSecond()
const;
375 const std::set<ome::xml::model::enums::PixelType>
376 getPixelTypes()
const;
379 const std::set<ome::xml::model::enums::PixelType>
380 getPixelTypes(
const std::string& codec)
const;
389 const std::string& codec)
const;
392 const std::set<std::string>&
393 getCompressionTypes()
const;
395 const std::set<std::string>&
400 setCompression(
const std::string& compression);
403 const boost::optional<std::string>&
404 getCompression()
const;
408 setInterleaved(
bool interleaved);
411 const boost::optional<bool>&
412 getInterleaved()
const;
416 changeOutputFile(
const boost::filesystem::path&
id);
420 setWriteSequentially(
bool sequential =
true);
424 getWriteSequentially()
const;
428 setId(
const boost::filesystem::path&
id);
432 close(
bool fileOnly =
false);
440 getFormatDescription()
const;
443 const std::vector<boost::filesystem::path>&
447 const std::vector<boost::filesystem::path>&
448 getCompressionSuffixes()
const;
455 #endif // OME_FILES_DETAIL_FORMATWRITER_H
pixel_compression_type_map pixel_compression_types
Supported compression codecs types for each pixel type.
Definition: FormatWriter.h:73
uint32_t pixel_size_type
Size type for pixel bit depths.
Definition: Types.h:61
std::size_t dimension_size_type
Size type for image dimensions.
Definition: Types.h:58
std::map< ome::xml::model::enums::PixelType, std::set< std::string > > pixel_compression_type_map
Map of codec to pixel types.
Definition: FormatWriter.h:60
WriterProperties(const std::string &name, const std::string &description)
Constructor.
Definition: FormatWriter.h:83
dimension_size_type getIndex(const std::string &order, dimension_size_type zSize, dimension_size_type cSize, dimension_size_type tSize, dimension_size_type num, dimension_size_type z, dimension_size_type c, dimension_size_type t)
Get the rasterized index corresponding to the given Z, C and T coordinates (real sizes).
Definition: FormatTools.cpp:365
std::set< std::string > compression_types
Supported compression types.
Definition: FormatWriter.h:71
Properties specific to a particular writer.
Definition: FormatWriter.h:56
Open Microscopy Environment C++.
std::string name
Format name.
Definition: FormatWriter.h:63
std::vector< boost::filesystem::path > suffixes
Filename suffixes this format can handle.
Definition: FormatWriter.h:67
std::array< dimension_size_type, 3 > getZCTCoords(const std::string &order, dimension_size_type zSize, dimension_size_type cSize, dimension_size_type tSize, dimension_size_type num, dimension_size_type index)
Get the Z, C and T coordinates (real sizes) corresponding to the given rasterized index value...
Definition: FormatTools.cpp:422
bool stacks
Stacks are supported.
Definition: FormatWriter.h:75
std::vector< boost::filesystem::path > compression_suffixes
Filename compression suffixes this format can handle.
Definition: FormatWriter.h:69
std::string description
Format description.
Definition: FormatWriter.h:65
Buffer for all pixel types.
Definition: VariantPixelBuffer.h:75