Expose the default Pole figure names so they can be used externally.

Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
BlueQuartzSoftware · Apr 13, 2023 · ed67bc5 · ed67bc5
1 parent b483b46
commit ed67bc5
Show file tree

Hide file tree

Showing 24 changed files with 217 additions and 36 deletions.
diff --git a/README.md b/README.md
@@ -48,9 +48,9 @@ can set to allow the orientation transformations to accept this layout.
 
 EbsdLib is dependent on:
 
-+ Qt5 5.12.x (minimum)
-+ Eigen 3.5
-+ HDF5 1.8.20 or 1.10.4 (HDF5 is optional only if you want the HDF5 functionality)
++ Qt5 5.15.x (minimum)
++ Eigen 3.4
++ HDF5 1.10.4 (HDF5 is optional only if you want the HDF5 functionality)
 
 ## Rotation Convention ##
 

diff --git a/Source/EbsdLib/LaueOps/CubicLowOps.cpp b/Source/EbsdLib/LaueOps/CubicLowOps.cpp
@@ -958,14 +958,23 @@ EbsdLib::Rgb CubicLowOps::generateRodriguesColor(double r1, double r2, double r3
   return EbsdLib::RgbColor::dRgb(static_cast<int32_t>(red * 255), static_cast<int32_t>(green * 255), static_cast<int32_t>(blue * 255), 255);
 }
 
+// -----------------------------------------------------------------------------
+//
+// -----------------------------------------------------------------------------
+std::array<std::string, 3> CubicLowOps::getDefaultPoleFigureNames() const
+{
+return {"<001>", "<011>", "<111>"}; 
+}
+
 // -----------------------------------------------------------------------------
 //
 // -----------------------------------------------------------------------------
 std::vector<EbsdLib::UInt8ArrayType::Pointer> CubicLowOps::generatePoleFigure(PoleFigureConfiguration_t& config) const
 {
-  std::string label0 = std::string("<001>");
-  std::string label1 = std::string("<011>");
-  std::string label2 = std::string("<111>");
+  std::array<std::string, 3>labels = getDefaultPoleFigureNames();
+  std::string label0 = labels[0];
+  std::string label1 = labels[1];
+  std::string label2 = labels[2];
   if(!config.labels.empty())
   {
     label0 = config.labels.at(0);

diff --git a/Source/EbsdLib/LaueOps/CubicLowOps.h b/Source/EbsdLib/LaueOps/CubicLowOps.h
@@ -224,6 +224,12 @@ class EbsdLib_EXPORT CubicLowOps : public LaueOps
    */
   std::vector<EbsdLib::UInt8ArrayType::Pointer> generatePoleFigure(PoleFigureConfiguration_t& config) const override;
 
+  /**
+   * @brief Returns the names for each of the three standard pole figures that are generated. For example
+   *<001>, <011> and <111> for a cubic system
+   */
+ std::array<std::string, 3> getDefaultPoleFigureNames() const override;
+
   /**
    * @brief generateStandardTriangle Generates an RGBA array that is a color "Standard" IPF Triangle Legend used for IPF Color Maps.
    * @return

diff --git a/Source/EbsdLib/LaueOps/CubicOps.cpp b/Source/EbsdLib/LaueOps/CubicOps.cpp
@@ -1745,14 +1745,26 @@ EbsdLib::Rgb CubicOps::generateRodriguesColor(double r1, double r2, double r3) c
   return EbsdLib::RgbColor::dRgb(static_cast<int32_t>(red * 255), static_cast<int32_t>(green * 255), static_cast<int32_t>(blue * 255), 255);
 }
 
+// -----------------------------------------------------------------------------
+//
+// -----------------------------------------------------------------------------
+std::array<std::string, 3> CubicOps::getDefaultPoleFigureNames() const
+{
+return {  "<001>",
+  "<011>",
+  "<111>"};
+}
+
 // -----------------------------------------------------------------------------
 //
 // -----------------------------------------------------------------------------
 std::vector<EbsdLib::UInt8ArrayType::Pointer> CubicOps::generatePoleFigure(PoleFigureConfiguration_t& config) const
 {
-  std::string label0 = std::string("<001>");
-  std::string label1 = std::string("<011>");
-  std::string label2 = std::string("<111>");
+  std::array<std::string, 3>labels = getDefaultPoleFigureNames();
+  std::string label0 = labels[0];
+  std::string label1 = labels[1];
+  std::string label2 = labels[2];
+
   if(!config.labels.empty())
   {
     label0 = config.labels.at(0);

diff --git a/Source/EbsdLib/LaueOps/CubicOps.h b/Source/EbsdLib/LaueOps/CubicOps.h
@@ -224,6 +224,12 @@ class EbsdLib_EXPORT CubicOps : public LaueOps
    */
   std::vector<EbsdLib::UInt8ArrayType::Pointer> generatePoleFigure(PoleFigureConfiguration_t& config) const override;
 
+  /**
+   * @brief Returns the names for each of the three standard pole figures that are generated. For example
+   *<001>, <011> and <111> for a cubic system
+   */
+ std::array<std::string, 3> getDefaultPoleFigureNames() const override;
+
   /**
    * @brief generateStandardTriangle Generates an RGBA array that is a color "Standard" IPF Triangle Legend used for IPF Color Maps.
    * @return

diff --git a/Source/EbsdLib/LaueOps/HexagonalLowOps.cpp b/Source/EbsdLib/LaueOps/HexagonalLowOps.cpp
@@ -1263,14 +1263,23 @@ EbsdLib::Rgb HexagonalLowOps::generateRodriguesColor(double r1, double r2, doubl
   return EbsdLib::RgbColor::dRgb(static_cast<int32_t>(red * 255), static_cast<int32_t>(green * 255), static_cast<int32_t>(blue * 255), 255);
 }
 
+// -----------------------------------------------------------------------------
+//
+// -----------------------------------------------------------------------------
+std::array<std::string, 3> HexagonalLowOps::getDefaultPoleFigureNames() const
+{
+return {"<0001>", "<11-20>", "<2-1-10>"}; 
+}
+
 // -----------------------------------------------------------------------------
 //
 // -----------------------------------------------------------------------------
 std::vector<EbsdLib::UInt8ArrayType::Pointer> HexagonalLowOps::generatePoleFigure(PoleFigureConfiguration_t& config) const
 {
-  std::string label0 = std::string("<0001>");
-  std::string label1 = std::string("<11-20>");
-  std::string label2 = std::string("<2-1-10>");
+  std::array<std::string, 3>labels = getDefaultPoleFigureNames();
+  std::string label0 = labels[0];
+  std::string label1 = labels[1];
+  std::string label2 = labels[2];
   if(!config.labels.empty())
   {
     label0 = config.labels.at(0);

diff --git a/Source/EbsdLib/LaueOps/HexagonalLowOps.h b/Source/EbsdLib/LaueOps/HexagonalLowOps.h
@@ -225,6 +225,12 @@ class EbsdLib_EXPORT HexagonalLowOps : public LaueOps
    */
   std::vector<EbsdLib::UInt8ArrayType::Pointer> generatePoleFigure(PoleFigureConfiguration_t& config) const override;
 
+  /**
+   * @brief Returns the names for each of the three standard pole figures that are generated. For example
+   *<001>, <011> and <111> for a cubic system
+   */
+ std::array<std::string, 3> getDefaultPoleFigureNames() const override;
+
   /**
    * @brief generateStandardTriangle Generates an RGBA array that is a color "Standard" IPF Triangle Legend used for IPF Color Maps.
    * @return

diff --git a/Source/EbsdLib/LaueOps/HexagonalOps.cpp b/Source/EbsdLib/LaueOps/HexagonalOps.cpp
@@ -1324,14 +1324,24 @@ EbsdLib::Rgb HexagonalOps::generateRodriguesColor(double r1, double r2, double r
   return EbsdLib::RgbColor::dRgb(static_cast<int32_t>(red * 255), static_cast<int32_t>(green * 255), static_cast<int32_t>(blue * 255), 255);
 }
 
+// -----------------------------------------------------------------------------
+//
+// -----------------------------------------------------------------------------
+std::array<std::string, 3> HexagonalOps::getDefaultPoleFigureNames() const
+{
+return {"<0001>", "<10-10>", "<2-1-10>"};
+}
+
 // -----------------------------------------------------------------------------
 //
 // -----------------------------------------------------------------------------
 std::vector<EbsdLib::UInt8ArrayType::Pointer> HexagonalOps::generatePoleFigure(PoleFigureConfiguration_t& config) const
 {
-  std::string label0 = std::string("<0001>");
-  std::string label1 = std::string("<10-10>");
-  std::string label2 = std::string("<2-1-10>");
+  std::array<std::string, 3>labels = getDefaultPoleFigureNames();
+  std::string label0 = labels[0];
+  std::string label1 = labels[1];
+  std::string label2 = labels[2];
+
   if(!config.labels.empty())
   {
     label0 = config.labels.at(0);

diff --git a/Source/EbsdLib/LaueOps/HexagonalOps.h b/Source/EbsdLib/LaueOps/HexagonalOps.h
@@ -225,6 +225,12 @@ class EbsdLib_EXPORT HexagonalOps : public LaueOps
    */
   std::vector<EbsdLib::UInt8ArrayType::Pointer> generatePoleFigure(PoleFigureConfiguration_t& config) const override;
 
+  /**
+   * @brief Returns the names for each of the three standard pole figures that are generated. For example
+   *<001>, <011> and <111> for a cubic system
+   */
+ std::array<std::string, 3> getDefaultPoleFigureNames() const override;
+
   /**
    * @brief generateStandardTriangle Generates an RGBA array that is a color "Standard" IPF Triangle Legend used for IPF Color Maps.
    * @return

diff --git a/Source/EbsdLib/LaueOps/LaueOps.h b/Source/EbsdLib/LaueOps/LaueOps.h
@@ -287,6 +287,12 @@ class EbsdLib_EXPORT LaueOps
    */
   virtual std::vector<EbsdLib::UInt8ArrayType::Pointer> generatePoleFigure(PoleFigureConfiguration_t& config) const = 0;
 
+  /**
+   * @brief Returns the names for each of the three standard pole figures that are generated. For example
+   *<001>, <011> and <111> for a cubic system
+   */
+  virtual std::array<std::string, 3> getDefaultPoleFigureNames() const = 0;
+
 protected:
   LaueOps();
 

diff --git a/Source/EbsdLib/LaueOps/MonoclinicOps.cpp b/Source/EbsdLib/LaueOps/MonoclinicOps.cpp
@@ -669,14 +669,24 @@ EbsdLib::Rgb MonoclinicOps::generateRodriguesColor(double r1, double r2, double
   return EbsdLib::RgbColor::dRgb(static_cast<int32_t>(red * 255), static_cast<int32_t>(green * 255), static_cast<int32_t>(blue * 255), 255);
 }
 
+// -----------------------------------------------------------------------------
+//
+// -----------------------------------------------------------------------------
+std::array<std::string, 3> MonoclinicOps::getDefaultPoleFigureNames() const
+{
+return {"<001>", "<100>", "<010>"};
+}
+
 // -----------------------------------------------------------------------------
 //
 // -----------------------------------------------------------------------------
 std::vector<EbsdLib::UInt8ArrayType::Pointer> MonoclinicOps::generatePoleFigure(PoleFigureConfiguration_t& config) const
 {
-  std::string label0 = std::string("<001>");
-  std::string label1 = std::string("<100>");
-  std::string label2 = std::string("<010>");
+  std::array<std::string, 3>labels = getDefaultPoleFigureNames();
+  std::string label0 = labels[0];
+  std::string label1 = labels[1];
+  std::string label2 = labels[2];
+
   if(!config.labels.empty())
   {
     label0 = config.labels.at(0);

diff --git a/Source/EbsdLib/LaueOps/MonoclinicOps.h b/Source/EbsdLib/LaueOps/MonoclinicOps.h
@@ -223,6 +223,12 @@ class EbsdLib_EXPORT MonoclinicOps : public LaueOps
    */
   std::vector<EbsdLib::UInt8ArrayType::Pointer> generatePoleFigure(PoleFigureConfiguration_t& config) const override;
 
+  /**
+   * @brief Returns the names for each of the three standard pole figures that are generated. For example
+   *<001>, <011> and <111> for a cubic system
+   */
+ std::array<std::string, 3> getDefaultPoleFigureNames() const override;
+
   /**
    * @brief generateStandardTriangle Generates an RGBA array that is a color "Standard" IPF Triangle Legend used for IPF Color Maps.
    * @return

diff --git a/Source/EbsdLib/LaueOps/OrthoRhombicOps.cpp b/Source/EbsdLib/LaueOps/OrthoRhombicOps.cpp
@@ -672,15 +672,24 @@ EbsdLib::Rgb OrthoRhombicOps::generateRodriguesColor(double r1, double r2, doubl
   return EbsdLib::RgbColor::dRgb(static_cast<int32_t>(red * 255), static_cast<int32_t>(green * 255), static_cast<int32_t>(blue * 255), 255);
 }
 
+// -----------------------------------------------------------------------------
+//
+// -----------------------------------------------------------------------------
+std::array<std::string, 3> OrthoRhombicOps::getDefaultPoleFigureNames() const
+{
+return {"<001>", "<100>", "<010>"};
+}
+
 // -----------------------------------------------------------------------------
 //
 // -----------------------------------------------------------------------------
 std::vector<EbsdLib::UInt8ArrayType::Pointer> OrthoRhombicOps::generatePoleFigure(PoleFigureConfiguration_t& config) const
 {
+  std::array<std::string, 3>labels = getDefaultPoleFigureNames();
+  std::string label0 = labels[0];
+  std::string label1 = labels[1];
+  std::string label2 = labels[2];
 
-  std::string label0 = std::string("<001>");
-  std::string label1 = std::string("<100>");
-  std::string label2 = std::string("<010>");
   if(!config.labels.empty())
   {
     label0 = config.labels.at(0);

diff --git a/Source/EbsdLib/LaueOps/OrthoRhombicOps.h b/Source/EbsdLib/LaueOps/OrthoRhombicOps.h
@@ -225,6 +225,12 @@ class EbsdLib_EXPORT OrthoRhombicOps : public LaueOps
    */
   std::vector<EbsdLib::UInt8ArrayType::Pointer> generatePoleFigure(PoleFigureConfiguration_t& config) const override;
 
+  /**
+   * @brief Returns the names for each of the three standard pole figures that are generated. For example
+   *<001>, <011> and <111> for a cubic system
+   */
+ std::array<std::string, 3> getDefaultPoleFigureNames() const override;
+
   /**
    * @brief generateStandardTriangle Generates an RGBA array that is a color "Standard" IPF Triangle Legend used for IPF Color Maps.
    * @return

diff --git a/Source/EbsdLib/LaueOps/TetragonalLowOps.cpp b/Source/EbsdLib/LaueOps/TetragonalLowOps.cpp
@@ -665,14 +665,24 @@ EbsdLib::Rgb TetragonalLowOps::generateRodriguesColor(double r1, double r2, doub
   return EbsdLib::RgbColor::dRgb(static_cast<int32_t>(red * 255), static_cast<int32_t>(green * 255), static_cast<int32_t>(blue * 255), 255);
 }
 
+// -----------------------------------------------------------------------------
+//
+// -----------------------------------------------------------------------------
+std::array<std::string, 3> TetragonalLowOps::getDefaultPoleFigureNames() const
+{
+return {"<001>", "<100>", "<010>"};
+}
+
 // -----------------------------------------------------------------------------
 //
 // -----------------------------------------------------------------------------
 std::vector<EbsdLib::UInt8ArrayType::Pointer> TetragonalLowOps::generatePoleFigure(PoleFigureConfiguration_t& config) const
 {
-  std::string label0 = std::string("<001>");
-  std::string label1 = std::string("<100>");
-  std::string label2 = std::string("<010>");
+  std::array<std::string, 3>labels = getDefaultPoleFigureNames();
+  std::string label0 = labels[0];
+  std::string label1 = labels[1];
+  std::string label2 = labels[2];
+
   if(!config.labels.empty())
   {
     label0 = config.labels.at(0);

diff --git a/Source/EbsdLib/LaueOps/TetragonalLowOps.h b/Source/EbsdLib/LaueOps/TetragonalLowOps.h
@@ -224,6 +224,12 @@ class EbsdLib_EXPORT TetragonalLowOps : public LaueOps
    */
   std::vector<EbsdLib::UInt8ArrayType::Pointer> generatePoleFigure(PoleFigureConfiguration_t& config) const override;
 
+  /**
+   * @brief Returns the names for each of the three standard pole figures that are generated. For example
+   *<001>, <011> and <111> for a cubic system
+   */
+ std::array<std::string, 3> getDefaultPoleFigureNames() const override;
+
   /**
    * @brief generateStandardTriangle Generates an RGBA array that is a color "Standard" IPF Triangle Legend used for IPF Color Maps.
    * @return

diff --git a/Source/EbsdLib/LaueOps/TetragonalOps.cpp b/Source/EbsdLib/LaueOps/TetragonalOps.cpp
@@ -702,14 +702,24 @@ EbsdLib::Rgb TetragonalOps::generateRodriguesColor(double r1, double r2, double
   return EbsdLib::RgbColor::dRgb(static_cast<int32_t>(red * 255), static_cast<int32_t>(green * 255), static_cast<int32_t>(blue * 255), 255);
 }
 
+// -----------------------------------------------------------------------------
+//
+// -----------------------------------------------------------------------------
+std::array<std::string, 3> TetragonalOps::getDefaultPoleFigureNames() const
+{
+return {"<001>", "<100>", "<110>"};
+}
+
 // -----------------------------------------------------------------------------
 //
 // -----------------------------------------------------------------------------
 std::vector<EbsdLib::UInt8ArrayType::Pointer> TetragonalOps::generatePoleFigure(PoleFigureConfiguration_t& config) const
 {
-  std::string label0 = std::string("<001>");
-  std::string label1 = std::string("<100>");
-  std::string label2 = std::string("<110>");
+  std::array<std::string, 3>labels = getDefaultPoleFigureNames();
+  std::string label0 = labels[0];
+  std::string label1 = labels[1];
+  std::string label2 = labels[2];
+
   if(!config.labels.empty())
   {
     label0 = config.labels.at(0);

diff --git a/Source/EbsdLib/LaueOps/TetragonalOps.h b/Source/EbsdLib/LaueOps/TetragonalOps.h
@@ -224,6 +224,12 @@ class EbsdLib_EXPORT TetragonalOps : public LaueOps
    */
   std::vector<EbsdLib::UInt8ArrayType::Pointer> generatePoleFigure(PoleFigureConfiguration_t& config) const override;
 
+  /**
+   * @brief Returns the names for each of the three standard pole figures that are generated. For example
+   *<001>, <011> and <111> for a cubic system
+   */
+ std::array<std::string, 3> getDefaultPoleFigureNames() const override;
+
   /**
    * @brief generateStandardTriangle Generates an RGBA array that is a color "Standard" IPF Triangle Legend used for IPF Color Maps.
    * @return

diff --git a/Source/EbsdLib/LaueOps/TriclinicOps.cpp b/Source/EbsdLib/LaueOps/TriclinicOps.cpp
@@ -664,14 +664,24 @@ EbsdLib::Rgb TriclinicOps::generateRodriguesColor(double r1, double r2, double r
   return EbsdLib::RgbColor::dRgb(static_cast<int32_t>(red * 255), static_cast<int32_t>(green * 255), static_cast<int32_t>(blue * 255), 255);
 }
 
+// -----------------------------------------------------------------------------
+//
+// -----------------------------------------------------------------------------
+std::array<std::string, 3> TriclinicOps::getDefaultPoleFigureNames() const
+{
+return {"<001>", "<100>", "<010>"};
+}
+
 // -----------------------------------------------------------------------------
 //
 // -----------------------------------------------------------------------------
 std::vector<EbsdLib::UInt8ArrayType::Pointer> TriclinicOps::generatePoleFigure(PoleFigureConfiguration_t& config) const
 {
-  std::string label0 = std::string("<001>");
-  std::string label1 = std::string("<100>");
-  std::string label2 = std::string("<010>");
+  std::array<std::string, 3>labels = getDefaultPoleFigureNames();
+  std::string label0 = labels[0];
+  std::string label1 = labels[1];
+  std::string label2 = labels[2];
+
   if(!config.labels.empty())
   {
     label0 = config.labels.at(0);

diff --git a/Source/EbsdLib/LaueOps/TriclinicOps.h b/Source/EbsdLib/LaueOps/TriclinicOps.h
@@ -224,6 +224,12 @@ class EbsdLib_EXPORT TriclinicOps : public LaueOps
    */
   std::vector<EbsdLib::UInt8ArrayType::Pointer> generatePoleFigure(PoleFigureConfiguration_t& config) const override;
 
+  /**
+   * @brief Returns the names for each of the three standard pole figures that are generated. For example
+   *<001>, <011> and <111> for a cubic system
+   */
+ std::array<std::string, 3> getDefaultPoleFigureNames() const override;
+
   /**
    * @brief generateStandardTriangle Generates an RGBA array that is a color "Standard" IPF Triangle Legend used for IPF Color Maps.
    * @return