ome-files  0.1.1
MetadataTools.h
1 /*
2  * #%L
3  * OME-FILES C++ library for image IO.
4  * Copyright © 2006 - 2015 Open Microscopy Environment:
5  * - Massachusetts Institute of Technology
6  * - National Institutes of Health
7  * - University of Dundee
8  * - Board of Regents of the University of Wisconsin-Madison
9  * - Glencoe Software, Inc.
10  * %%
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions are met:
13  *
14  * 1. Redistributions of source code must retain the above copyright notice,
15  * this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright notice,
17  * this list of conditions and the following disclaimer in the documentation
18  * and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  *
32  * The views and conclusions contained in the software and documentation are
33  * those of the authors and should not be interpreted as representing official
34  * policies, either expressed or implied, of any organization.
35  * #L%
36  */
37 
38 #include <string>
39 
40 #include <ome/files/FormatReader.h>
41 #include <ome/files/MetadataMap.h>
42 #include <ome/files/Types.h>
43 
44 #include <ome/common/filesystem.h>
45 
46 #include <ome/xml/meta/Metadata.h>
47 #include <ome/xml/meta/MetadataRoot.h>
48 #include <ome/xml/meta/OMEXMLMetadata.h>
49 
50 #include <ome/xml/model/enums/DimensionOrder.h>
51 
52 #ifndef OME_FILES_METADATATOOLS_H
53 #define OME_FILES_METADATATOOLS_H
54 
55 namespace ome
56 {
57  namespace files
58  {
59 
60  // Use overloaded functions for creating identifiers since
61  // pre-C++11 compilers don't support the C99 stdarg interface.
62 
70  std::string
71  createID(std::string const& type,
73 
82  std::string
83  createID(std::string const& type,
85  dimension_size_type idx2);
86 
96  std::string
97  createID(std::string const& type,
100  dimension_size_type idx3);
101 
112  std::string
113  createID(std::string const& type,
114  dimension_size_type idx1,
115  dimension_size_type idx2,
116  dimension_size_type idx3,
117  dimension_size_type idx4);
118 
125  ome::compat::shared_ptr< ::ome::xml::meta::OMEXMLMetadata>
127 
134  ome::compat::shared_ptr< ::ome::xml::meta::OMEXMLMetadata>
135  createOMEXMLMetadata(const boost::filesystem::path& file);
136 
143  ome::compat::shared_ptr< ::ome::xml::meta::OMEXMLMetadata>
144  createOMEXMLMetadata(const std::string& text);
145 
152  ome::compat::shared_ptr< ::ome::xml::meta::OMEXMLMetadata>
153  createOMEXMLMetadata(std::istream& stream);
154 
163  ome::compat::shared_ptr< ::ome::xml::meta::OMEXMLMetadata>
164  createOMEXMLMetadata(const FormatReader& reader,
165  bool doPlane = false,
166  bool doImageName = true);
167 
168 
175  ome::compat::shared_ptr< ::ome::xml::meta::MetadataRoot>
176  createOMEXMLRoot(const std::string& document);
177 
186  ome::compat::shared_ptr< ::ome::xml::meta::OMEXMLMetadata>
187  getOMEXMLMetadata(ome::compat::shared_ptr< ::ome::xml::meta::MetadataRetrieve>& retrieve);
188 
200  std::string
202  bool validate = true);
203 
210  bool
211  validateOMEXML(const std::string& document);
212 
227  bool
229  bool correct);
230 
241  void
243  const FormatReader& reader,
244  bool doPlane = false,
245  bool doImageName = true);
246 
256  void
258  const std::vector<ome::compat::shared_ptr<CoreMetadata> > seriesList,
259  bool doPlane = false);
260 
269  void
271  const FormatReader& reader);
272 
281  void
283  const FormatReader& reader);
284 
294  void
296  const CoreMetadata& seriesMetadata,
297  dimension_size_type series);
298 
308  void
310  dimension_size_type series,
311  bool resolve = true);
312 
320  Modulo
321  getModuloAlongZ(const ::ome::xml::meta::OMEXMLMetadata& omexml,
322  dimension_size_type image);
323 
331  Modulo
332  getModuloAlongT(const ::ome::xml::meta::OMEXMLMetadata& omexml,
333  dimension_size_type image);
334 
342  Modulo
343  getModuloAlongC(const ::ome::xml::meta::OMEXMLMetadata& omexml,
344  dimension_size_type image);
345 
354  Modulo
355  getModulo(const ::ome::xml::meta::OMEXMLMetadata& omexml,
356  const std::string& tag,
357  dimension_size_type image);
358 
366  void
368  dimension_size_type series = 0U);
369 
375  void
377 
386  void
388  dimension_size_type image,
389  dimension_size_type sizeC);
390 
397  MetadataMap
399 
406  void
408  const MetadataMap& metadata);
409 
415  bool
417 
423  std::string
424  getModelVersion();
425 
432  std::string
434 
441  std::string
442  getModelVersion(const std::string& document);
443 
450  std::string
451  transformToLatestModelVersion(const std::string& document);
452 
463  void
464  defaultCreationDateEnabled(bool enabled);
465 
480  void
482  dimension_size_type series,
483  const boost::filesystem::path& id);
484 
499  createDimensionOrder(const std::string& order);
500 
512  pixelSize(const ::ome::xml::meta::MetadataRetrieve& meta,
513  dimension_size_type series);
514 
525  pixelSize(const ::ome::xml::meta::MetadataRetrieve& meta);
526 
527 
539  significantPixelSize(const ::ome::xml::meta::MetadataRetrieve& meta,
540  dimension_size_type series);
541 
552  significantPixelSize(const ::ome::xml::meta::MetadataRetrieve& meta);
553 
554  }
555 }
556 
557 #endif // OME_FILES_METADATATOOLS_H
558 
559 /*
560  * Local Variables:
561  * mode:C++
562  * End:
563  */
bool defaultCreationDateEnabled()
Check if default creation date is enabled.
Definition: MetadataTools.cpp:1159
bool validateModel(::ome::xml::meta::Metadata &meta, bool correct)
Validate a metadata store.
Definition: MetadataTools.cpp:396
std::size_t dimension_size_type
Size type for image dimensions.
Definition: Types.h:59
uint64_t storage_size_type
Size type for storage size.
Definition: Types.h:65
std::string getOMEXML(::ome::xml::meta::OMEXMLMetadata &omexml, bool validate)
Get OME-XML document from OME-XML metadata.
Definition: MetadataTools.cpp:378
void fillOriginalMetadata(::ome::xml::meta::OMEXMLMetadata &omexml, const MetadataMap &metadata)
Create OriginalMetadataAnnotations from MetadataMap.
Definition: MetadataTools.cpp:1012
void removeBinData(::ome::xml::meta::OMEXMLMetadata &omexml)
Remove all BinData elements from OME-XML metadata.
Definition: MetadataTools.cpp:872
void removeChannels(::ome::xml::meta::OMEXMLMetadata &omexml, dimension_size_type image, dimension_size_type sizeC)
Remove all but the specified number of valid Channel elements from OME-XML metadata.
Definition: MetadataTools.cpp:903
void fillPixels(::ome::xml::meta::MetadataStore &store, const FormatReader &reader)
Fill an OME-XML metadata store Pixels element from reader core metadata.
Definition: MetadataTools.cpp:640
std::string createID(std::string const &type, dimension_size_type idx)
Create an object identifier for a given object type and index.
Definition: MetadataTools.cpp:178
Modulo getModuloAlongT(const ::ome::xml::meta::OMEXMLMetadata &omexml, dimension_size_type image)
Get ModuloAlongT annotation from OME-XML metadata.
Definition: MetadataTools.cpp:735
ome::compat::shared_ptr< ::ome::xml::meta::MetadataRoot > createOMEXMLRoot(const std::string &document)
Create OME-XML metadata root from XML document.
Definition: MetadataTools.cpp:347
void addMetadataOnly(::ome::xml::meta::OMEXMLMetadata &omexml, dimension_size_type series, bool resolve)
Add a MetadataOnly element to Pixels for the specified series.
Definition: MetadataTools.cpp:704
Modulo getModuloAlongC(const ::ome::xml::meta::OMEXMLMetadata &omexml, dimension_size_type image)
Get ModuloAlongC annotation from OME-XML metadata.
Definition: MetadataTools.cpp:742
storage_size_type significantPixelSize(const ::ome::xml::meta::MetadataRetrieve &meta, dimension_size_type series)
Get the total significant size of pixel data in a series.
Definition: MetadataTools.cpp:1250
ome::compat::shared_ptr< ::ome::xml::meta::OMEXMLMetadata > createOMEXMLMetadata(ome::common::xml::dom::Document &document)
Create OME-XML metadata from DOM Document.
Definition: MetadataTools.cpp:224
void setDefaultCreationDate(::ome::xml::meta::MetadataStore &store, dimension_size_type series, const boost::filesystem::path &id)
Set the creation data for a series.
Definition: MetadataTools.cpp:1171
std::string transformToLatestModelVersion(const std::string &document)
Transform an OME-XML document to the latest model version.
Definition: MetadataTools.cpp:1146
bool validateOMEXML(const std::string &document)
Validate an OME-XML document.
Definition: MetadataTools.cpp:390
ome::compat::shared_ptr< ::ome::xml::meta::OMEXMLMetadata > getOMEXMLMetadata(ome::compat::shared_ptr< ::ome::xml::meta::MetadataRetrieve > &retrieve)
Get OME-XML metadata from metadata.
Definition: MetadataTools.cpp:356
MetadataMap getOriginalMetadata(::ome::xml::meta::OMEXMLMetadata &omexml)
Get original metadata from OME-XML metadata StructuredAnnotations.
Definition: MetadataTools.cpp:930
void verifyMinimum(::ome::xml::meta::MetadataRetrieve &retrieve, dimension_size_type series)
Verify correctness of minimal amount of metadata in a series.
Definition: MetadataTools.cpp:824
Modulo getModulo(const ::ome::xml::meta::OMEXMLMetadata &omexml, const std::string &tag, dimension_size_type image)
Get Modulo annotation from OME-XML metadata.
Definition: MetadataTools.cpp:749
Modulo getModuloAlongZ(const ::ome::xml::meta::OMEXMLMetadata &omexml, dimension_size_type image)
Get ModuloAlongZ annotation from OME-XML metadata.
Definition: MetadataTools.cpp:728
void fillMetadata(::ome::xml::meta::MetadataStore &store, const FormatReader &reader, bool doPlane, bool doImageName)
Fill OME-XML metadata store from reader core metadata.
Definition: MetadataTools.cpp:517
ome::xml::model::enums::DimensionOrder createDimensionOrder(const std::string &order)
Create a valid DimensionOrder from string.
Definition: MetadataTools.cpp:1185
storage_size_type pixelSize(const ::ome::xml::meta::MetadataRetrieve &meta, dimension_size_type series)
Get the total size of pixel data in a series.
Definition: MetadataTools.cpp:1215
void fillAllPixels(::ome::xml::meta::MetadataStore &store, const FormatReader &reader)
Fill all OME-XML metadata store Pixels elements from reader core metadata.
Definition: MetadataTools.cpp:627
std::string getModelVersion()
Get the currently-supported OME Data Model version.
Definition: MetadataTools.cpp:1067