mitk: mitkPropertySerializationTest.cpp Source File

Go to the documentation of this file.
00001 /*=========================================================================
00002  
00003 Program:   Medical Imaging & Interaction Toolkit
00004 Language:  C++
00005 Date:      $Date$
00006 Version:   $Revision: 1.12 $
00007  
00008 Copyright (c) German Cancer Research Center, Division of Medical and
00009 Biological Informatics. All rights reserved.
00010 See MITKCopyright.txt or https://www.mitk.org/copyright.html for details.
00011  
00012 This software is distributed WITHOUT ANY WARRANTY; without even
00013 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
00014 PURPOSE.  See the above copyright notices for more information.
00015  
00016 =========================================================================*/
00017 
00018 #include "mitkTestingMacros.h"
00019 
00020 #include "mitkDataNodeFactory.h"
00021 #include "mitkCoreObjectFactory.h"
00022 
00023 #include "mitkBaseProperty.h"
00024 #include "mitkProperties.h"
00025 #include <mitkAnnotationProperty.h>
00026 #include <mitkClippingProperty.h>
00027 #include <mitkColorProperty.h>
00028 #include <mitkEnumerationProperty.h>
00029 /*
00030 #include <mitkGridRepresentationProperty.h>
00031 #include <mitkGridVolumeMapperProperty.h>
00032 #include <mitkOrganTypeProperty.h>
00033 */
00034 #include <mitkModalityProperty.h>
00035 //#include <mitkOdfNormalizationMethodProperty.h>
00036 //#include <mitkOdfScaleByProperty.h>
00037 #include <mitkPlaneOrientationProperty.h>
00038 #include <mitkShaderProperty.h>
00039 #include <mitkVtkInterpolationProperty.h>
00040 #include <mitkVtkRepresentationProperty.h>
00041 #include <mitkVtkResliceInterpolationProperty.h>
00042 #include <mitkVtkScalarModeProperty.h>
00043 #include <mitkVtkVolumeRenderingProperty.h>
00044 #include <mitkGroupTagProperty.h>
00045 #include <mitkLevelWindowProperty.h>
00046 #include <mitkLookupTableProperty.h>
00047 #include <mitkStringProperty.h>
00048 #include <mitkTransferFunctionProperty.h>
00049 
00050 #include "mitkPropertyList.h"
00051 #include "mitkPropertyListSerializer.h"
00052 #include "mitkBasePropertySerializer.h"
00053 #include "mitkBasePropertyDeserializer.h"
00054 
00055 #include <mitkPointSet.h>
00056 #include <mitkImage.h>
00057 #include <mitkSurface.h>
00058 #include <mitkVtkWidgetRendering.h>
00059 
00060 /*
00061 #include <mitkContour.h>
00062 #include <mitkContourSet.h>
00063 #include <mitkPointData.h>
00064 #include <mitkMesh.h>
00065 #include <mitkCone.h>
00066 #include <mitkCuboid.h>
00067 #include <mitkCylinder.h>
00068 #include <mitkEllipsoid.h>
00069 #include <mitkExtrudedContour.h>
00070 #include <mitkPlane.h>
00071 #include <mitkUnstructuredGrid.h>
00072 */
00073 
00074 void TestAllProperties(const mitk::PropertyList* propList);
00075 
00080 int mitkPropertySerializationTest(int /* argc */, char* /*argv*/[])
00081 {
00082   MITK_TEST_BEGIN("PropertySerializationTest");
00083 
00084   mitk::PropertyListSerializer::Pointer serializer = mitk::PropertyListSerializer::New(); // make sure something from the lib is actually used (registration of serializers/deserializers)
00085 
00086   /* build list of properties that will be serialized and deserialized */
00087   mitk::PropertyList::Pointer propList = mitk::PropertyList::New();
00088   propList->SetProperty("booltrue", mitk::BoolProperty::New(true));
00089   propList->SetProperty("boolfalse", mitk::BoolProperty::New(false));
00090   propList->SetProperty("int", mitk::IntProperty::New(-32));
00091   propList->SetProperty("float", mitk::FloatProperty::New(-31.337));
00092   propList->SetProperty("double", mitk::DoubleProperty::New(-31.337));
00093   propList->SetProperty("string", mitk::StringProperty::New("Hello MITK"));
00094   mitk::Point3D p3d;
00095   mitk::FillVector3D(p3d, 1.0, 2.2, -3.3);
00096   propList->SetProperty("p3d", mitk::Point3dProperty::New(p3d));
00097   mitk::Point3I p3i;
00098   mitk::FillVector3D(p3i, 1, 2, -3);
00099   propList->SetProperty("p3i", mitk::Point3iProperty::New(p3i));
00100   mitk::Point4D p4d;
00101   mitk::FillVector4D(p4d, 1.5, 2.6, -3.7, 4.44);
00102   propList->SetProperty("p4d", mitk::Point4dProperty::New(p4d));
00103   mitk::Vector3D v3d;
00104   mitk::FillVector3D(v3d, 1.0, 2.2, -3.3);
00105   propList->SetProperty("v3d", mitk::Vector3DProperty::New(v3d));
00106   propList->SetProperty("annotation", mitk::AnnotationProperty::New("My Annotation", p3d));
00107   propList->SetProperty("clipping", mitk::ClippingProperty::New(p3d, v3d));
00108   propList->SetProperty("color", mitk::ColorProperty::New(1.0, 0.2, 0.2));
00109   //mitk::EnumerationProperty::Pointer en = mitk::EnumerationProperty::New();
00110   //en->AddEnum("PC", 1); en->AddEnum("Playstation", 2); en->AddEnum("Wii", 111); en->AddEnum("XBox", 7);
00111   //en->SetValue("XBox");
00112   //propList->SetProperty("enum", en);
00113   /*
00114   propList->SetProperty("gridrep", mitk::GridRepresentationProperty::New(2));
00115   propList->SetProperty("gridvol", mitk::GridVolumeMapperProperty::New(0));
00116   propList->SetProperty("OrganTypeProperty", mitk::OrganTypeProperty::New("Larynx"));
00117   */
00118   propList->SetProperty("modality", mitk::ModalityProperty::New("Color Doppler"));
00119   //propList->SetProperty("OdfNormalizationMethodProperty", mitk::OdfNormalizationMethodProperty::New("Global Maximum"));
00120   //propList->SetProperty("OdfScaleByProperty", mitk::OdfScaleByProperty::New("Principal Curvature"));
00121   propList->SetProperty("PlaneOrientationProperty", mitk::PlaneOrientationProperty::New("Arrows in positive direction"));
00122   propList->SetProperty("ShaderProperty", mitk::ShaderProperty::New("fixed"));
00123   propList->SetProperty("VtkInterpolationProperty", mitk::VtkInterpolationProperty::New("Gouraud"));
00124   propList->SetProperty("VtkRepresentationProperty", mitk::VtkRepresentationProperty::New("Surface"));
00125   propList->SetProperty("VtkResliceInterpolationProperty", mitk::VtkResliceInterpolationProperty::New("Cubic"));
00126   propList->SetProperty("VtkScalarModeProperty", mitk::VtkScalarModeProperty::New("PointFieldData"));
00127   propList->SetProperty("VtkVolumeRenderingProperty", mitk::VtkVolumeRenderingProperty::New("COMPOSITE"));
00128   mitk::BoolLookupTable blt;
00129   blt.SetTableValue(0, true);  blt.SetTableValue(1, false);  blt.SetTableValue(2, true);
00130   propList->SetProperty("BoolLookupTableProperty", mitk::BoolLookupTableProperty::New(blt));
00131   mitk::FloatLookupTable flt;
00132   flt.SetTableValue(0, 3.1);  flt.SetTableValue(1, 3.3);  flt.SetTableValue(2, 7.0);
00133   propList->SetProperty("FloatLookupTableProperty", mitk::FloatLookupTableProperty::New(flt));
00134   mitk::IntLookupTable ilt;
00135   ilt.SetTableValue(0, 3);  ilt.SetTableValue(1, 2);  ilt.SetTableValue(2, 11);
00136   propList->SetProperty("IntLookupTableProperty", mitk::IntLookupTableProperty::New(ilt));
00137   mitk::StringLookupTable slt;
00138   slt.SetTableValue(0, "Hello");  slt.SetTableValue(1, "MITK");  slt.SetTableValue(2, "world");
00139   propList->SetProperty("StringLookupTableProperty", mitk::StringLookupTableProperty::New(slt));
00140   propList->SetProperty("GroupTagProperty", mitk::GroupTagProperty::New());
00141   propList->SetProperty("LevelWindowProperty", mitk::LevelWindowProperty::New(mitk::LevelWindow(100.0, 50.0)));
00142   mitk::LookupTable::Pointer lt = mitk::LookupTable::New();
00143   lt->ChangeOpacityForAll(0.25); 
00144   lt->ChangeOpacity(17, 0.88);
00145   propList->SetProperty("LookupTableProperty", mitk::LookupTableProperty::New(lt));
00146   propList->SetProperty("StringProperty", mitk::StringProperty::New("Oh why, gruel world"));
00147   //mitk::TransferFunction::Pointer tf = mitk::TransferFunction::New();
00148   //tf->SetTransferFunctionMode(1);
00149   //propList->SetProperty("TransferFunctionProperty", mitk::TransferFunctionProperty::New(tf));
00150 
00151 
00152   MITK_TEST_CONDITION_REQUIRED(propList->GetMap()->size() > 0, "Initialize PropertyList");
00153 
00154   TestAllProperties(propList);
00155   
00156   /* test default property lists of basedata objects */
00157   // activate the following tests after MaterialProperty is deleted
00158 
00159   mitk::DataNode::Pointer node = mitk::DataNode::New();
00160   node->SetData(mitk::PointSet::New());
00161   TestAllProperties(node->GetPropertyList());
00162   node->SetData(mitk::Image::New());
00163   TestAllProperties(node->GetPropertyList());
00164   node->SetData(mitk::Surface::New());
00165   TestAllProperties(node->GetPropertyList());
00166   node->SetData(mitk::VtkWidgetRendering::New());
00167   TestAllProperties(node->GetPropertyList());
00168 
00169   /*
00170   node->SetData(mitk::Contour::New());
00171   TestAllProperties(node->GetPropertyList());
00172   node->SetData(mitk::ContourSet::New());
00173   TestAllProperties(node->GetPropertyList());
00174   node->SetData(mitk::PointData::New());
00175   TestAllProperties(node->GetPropertyList());
00176   node->SetData(mitk::Mesh::New());
00177   TestAllProperties(node->GetPropertyList());
00178   node->SetData(mitk::Cone::New());
00179   TestAllProperties(node->GetPropertyList());
00180   node->SetData(mitk::Cuboid::New());
00181   TestAllProperties(node->GetPropertyList());
00182   node->SetData(mitk::Cylinder::New());
00183   TestAllProperties(node->GetPropertyList());
00184   node->SetData(mitk::Ellipsoid::New());
00185   TestAllProperties(node->GetPropertyList());
00186   node->SetData(mitk::ExtrudedContour::New());
00187   TestAllProperties(node->GetPropertyList());
00188   node->SetData(mitk::Plane::New());
00189   TestAllProperties(node->GetPropertyList());
00190   //node->SetData(mitk::TrackingVolume::New());  // TrackingVolume is in IGT Module, it does not have special properties, therefore we skip it here
00191   //TestAllProperties(node->GetPropertyList());
00192   node->SetData(mitk::UnstructuredGrid::New());
00193   TestAllProperties(node->GetPropertyList());
00194   */
00195 
00196 /* untested base data types:
00197   BaseDataTestImplementation
00198   RenderWindowFrame
00199   mitk::DiffusionImage< TPixelType >
00200   GeometryData
00201   mitk::Geometry2DData
00202   GradientBackground
00203   ItkBaseDataAdapter
00204   ManufacturerLogo
00205   SlicedData
00206   QBallImage
00207   SeedsImage
00208   TensorImage 
00209   BoundingObject
00210   BoundingObjectGroup 
00211   */
00212 
00213   MITK_TEST_END();
00214 }
00215 
00216 void TestAllProperties(const mitk::PropertyList* propList)
00217 {
00218   assert(propList);
00219 
00220   /* try to serialize each property in the list, then deserialize again and check for equality */
00221   for (mitk::PropertyList::PropertyMap::const_iterator it = propList->GetMap()->begin(); it != propList->GetMap()->end(); ++it)
00222   {
00223     const mitk::BaseProperty* prop = it->second.first;
00224     // construct name of serializer class
00225     std::string serializername = std::string(prop->GetNameOfClass()) + "Serializer";
00226     std::list<itk::LightObject::Pointer> allSerializers = itk::ObjectFactoryBase::CreateAllInstance(serializername.c_str());
00227     MITK_TEST_CONDITION(allSerializers.size() > 0, std::string("Creating serializers for ") + serializername);
00228     if (allSerializers.size() == 0)
00229     {
00230       MITK_TEST_OUTPUT( << "serialization not possible, skipping " << prop->GetNameOfClass());
00231       continue;
00232     }
00233     if (allSerializers.size() > 1)
00234     {
00235       MITK_TEST_OUTPUT (<< "Warning: " << allSerializers.size() << " serializers found for " << prop->GetNameOfClass() << "testing only the first one.");
00236     }
00237     mitk::BasePropertySerializer* serializer = dynamic_cast<mitk::BasePropertySerializer*>( allSerializers.begin()->GetPointer());
00238     MITK_TEST_CONDITION(serializer != NULL, serializername + std::string(" is valid"));
00239     if (serializer != NULL)
00240     {
00241       serializer->SetProperty(prop);
00242       TiXmlElement* valueelement = NULL;
00243       try
00244       {
00245         valueelement = serializer->Serialize();
00246       }
00247       catch (...)
00248       {
00249       }
00250       MITK_TEST_CONDITION(valueelement != NULL, std::string("Serialize property with ") + serializername);
00251 
00252       if (valueelement == NULL)
00253       {
00254         MITK_TEST_OUTPUT( << "serialization failed, skipping deserialization");
00255         continue;
00256       }
00257       /* build deserializer and try to deserialize property */
00258       std::string deserializerName = std::string(prop->GetNameOfClass()) + std::string("Deserializer");
00259       std::list<itk::LightObject::Pointer> allDeserializers = itk::ObjectFactoryBase::CreateAllInstance(deserializerName.c_str());
00260       MITK_TEST_CONDITION(allDeserializers.size() > 0, std::string("Creating deserializers for ") + deserializerName);
00261       if (allDeserializers.size() == 0)
00262       {
00263         MITK_TEST_OUTPUT( << "deserialization not possible, skipping deserialization of " << prop->GetNameOfClass());
00264         continue;
00265       }
00266       if (allDeserializers.size() > 1)
00267       {
00268         MITK_TEST_OUTPUT (<< "Warning: " << allDeserializers.size() << " deserializers found for " << prop->GetNameOfClass() << "testing only the first one.");
00269       }
00270       mitk::BasePropertyDeserializer* deserializer = dynamic_cast<mitk::BasePropertyDeserializer*>( allDeserializers.begin()->GetPointer());
00271       MITK_TEST_CONDITION(deserializer != NULL, deserializerName + std::string(" is valid"));
00272       if (deserializer != NULL)
00273       {
00274         mitk::BaseProperty::Pointer deserializedProp = deserializer->Deserialize( valueelement );
00275         MITK_TEST_CONDITION(deserializedProp.IsNotNull(), "deserializer created valid property");
00276         if (deserializedProp.IsNotNull())
00277         {
00278           MITK_TEST_CONDITION(*(deserializedProp.GetPointer()) == *prop, "deserialized property equals initial property for type " << prop->GetNameOfClass());
00279         }
00280       }
00281     }
00282     else
00283     {
00284       MITK_TEST_OUTPUT( << "created serializer object is of class " << allSerializers.begin()->GetPointer()->GetNameOfClass())
00285     }
00286   } // for all properties
00287 }