Skip to content

Commit

Permalink
ENH: rename instances where DataStructure data to DataStructure dataS…
Browse files Browse the repository at this point in the history
…tructure

Signed-off-by: Michael Jackson <[email protected]>
  • Loading branch information
imikejackson committed Apr 28, 2024
1 parent f693435 commit e791714
Show file tree
Hide file tree
Showing 226 changed files with 927 additions and 685 deletions.
4 changes: 2 additions & 2 deletions scripts/filter.cpp.in
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,15 @@ IFilter::UniquePointer @FILTER_NAME@::clone() const
return std::make_unique<@FILTER_NAME@>();
}

IFilter::PreflightResult @FILTER_NAME@::preflightImpl(const DataStructure& data, const Arguments& args) const
IFilter::PreflightResult @FILTER_NAME@::preflightImpl(const DataStructure& dataStructure, const Arguments& args) const
{
/****************************************************************************
* Write any preflight sanity checking codes in this function
***************************************************************************/
return {};
}

Result<> @FILTER_NAME@::executeImpl(DataStructure& data, const Arguments& args) const
Result<> @FILTER_NAME@::executeImpl(DataStructure& dataStructure, const Arguments& args) const
{
/****************************************************************************
* Write your algorithm implementation in this function
Expand Down
4 changes: 2 additions & 2 deletions scripts/filter.hpp.in
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,15 @@ protected:
* @param args
* @return
*/
PreflightResult preflightImpl(const DataStructure& data, const Arguments& args) const override;
PreflightResult preflightImpl(const DataStructure& dataStructure, const Arguments& args) const override;

/**
* @brief
* @param data
* @param args
* @return
*/
Result<> executeImpl(DataStructure& data, const Arguments& args) const override;
Result<> executeImpl(DataStructure& dataStructure, const Arguments& args) const override;
};
} // namespace nx::core

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,8 @@ class ITKIMAGEPROCESSING_EXPORT ITKImageReaderFilter : public IFilter
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
Result<> executeImpl(DataStructure& data, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
Result<> executeImpl(DataStructure& dataStructure, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler,
const std::atomic_bool& shouldCancel) const override;
};
} // namespace nx::core

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,8 @@ class ITKIMAGEPROCESSING_EXPORT ITKImageWriterFilter : public IFilter
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
Result<> executeImpl(DataStructure& data, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
Result<> executeImpl(DataStructure& dataStructure, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler,
const std::atomic_bool& shouldCancel) const override;
};
} // namespace nx::core

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,8 @@ class ITKIMAGEPROCESSING_EXPORT ITKImportFijiMontageFilter : public IFilter
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
Result<> executeImpl(DataStructure& data, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
Result<> executeImpl(DataStructure& dataStructure, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler,
const std::atomic_bool& shouldCancel) const override;

private:
int32 m_InstanceId;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,8 @@ class ITKIMAGEPROCESSING_EXPORT ITKImportImageStackFilter : public IFilter
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
Result<> executeImpl(DataStructure& data, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
Result<> executeImpl(DataStructure& dataStructure, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler,
const std::atomic_bool& shouldCancel) const override;
};
} // namespace nx::core

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,8 @@ class ITKIMAGEPROCESSING_EXPORT ITKMhaFileReaderFilter : public IFilter
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
Result<> executeImpl(DataStructure& data, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
Result<> executeImpl(DataStructure& dataStructure, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler,
const std::atomic_bool& shouldCancel) const override;
};
} // namespace nx::core

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,8 @@ class ORIENTATIONANALYSIS_EXPORT AlignSectionsMisorientationFilter : public IFil
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
Result<> executeImpl(DataStructure& data, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
Result<> executeImpl(DataStructure& dataStructure, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler,
const std::atomic_bool& shouldCancel) const override;
};
} // namespace nx::core

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,8 @@ class ORIENTATIONANALYSIS_EXPORT AlignSectionsMutualInformationFilter : public I
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
Result<> executeImpl(DataStructure& data, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
Result<> executeImpl(DataStructure& dataStructure, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler,
const std::atomic_bool& shouldCancel) const override;
};
} // namespace nx::core

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,8 @@ class ORIENTATIONANALYSIS_EXPORT BadDataNeighborOrientationCheckFilter : public
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
Result<> executeImpl(DataStructure& data, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
Result<> executeImpl(DataStructure& dataStructure, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler,
const std::atomic_bool& shouldCancel) const override;
};
} // namespace nx::core

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ class ORIENTATIONANALYSIS_EXPORT CAxisSegmentFeaturesFilter : public IFilter
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
PreflightResult preflightImpl(const DataStructure& ds, const Arguments& filterArgs, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
PreflightResult preflightImpl(const DataStructure& dataStructure, const Arguments& filterArgs, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;

/**
* @brief Applies the filter's algorithm to the DataStructure with the given arguments. Returns any warnings/errors.
Expand All @@ -105,7 +105,8 @@ class ORIENTATIONANALYSIS_EXPORT CAxisSegmentFeaturesFilter : public IFilter
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
Result<> executeImpl(DataStructure& data, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
Result<> executeImpl(DataStructure& dataStructure, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler,
const std::atomic_bool& shouldCancel) const override;
};
} // namespace nx::core

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,8 @@ class ORIENTATIONANALYSIS_EXPORT ConvertHexGridToSquareGridFilter : public IFilt
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
Result<> executeImpl(DataStructure& data, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
Result<> executeImpl(DataStructure& dataStructure, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler,
const std::atomic_bool& shouldCancel) const override;

private:
int32 m_InstanceId;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,8 @@ class ORIENTATIONANALYSIS_EXPORT ConvertOrientationsFilter : public IFilter
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
Result<> executeImpl(DataStructure& data, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
Result<> executeImpl(DataStructure& dataStructure, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler,
const std::atomic_bool& shouldCancel) const override;
};
} // namespace nx::core

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,8 @@ class ORIENTATIONANALYSIS_EXPORT ConvertQuaternionFilter : public IFilter
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
Result<> executeImpl(DataStructure& data, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
Result<> executeImpl(DataStructure& dataStructure, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler,
const std::atomic_bool& shouldCancel) const override;
};
} // namespace nx::core

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,8 @@ class ORIENTATIONANALYSIS_EXPORT CreateEnsembleInfoFilter : public IFilter
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
Result<> executeImpl(DataStructure& data, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
Result<> executeImpl(DataStructure& dataStructure, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler,
const std::atomic_bool& shouldCancel) const override;
};
} // namespace nx::core

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,8 @@ class ORIENTATIONANALYSIS_EXPORT EBSDSegmentFeaturesFilter : public IFilter
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
Result<> executeImpl(DataStructure& data, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
Result<> executeImpl(DataStructure& dataStructure, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler,
const std::atomic_bool& shouldCancel) const override;
};
} // namespace nx::core

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,8 @@ class ORIENTATIONANALYSIS_EXPORT EbsdToH5EbsdFilter : public IFilter
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
Result<> executeImpl(DataStructure& data, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
Result<> executeImpl(DataStructure& dataStructure, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler,
const std::atomic_bool& shouldCancel) const override;
};
} // namespace nx::core

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ class ORIENTATIONANALYSIS_EXPORT FindAvgCAxesFilter : public IFilter
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
PreflightResult preflightImpl(const DataStructure& ds, const Arguments& filterArgs, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
PreflightResult preflightImpl(const DataStructure& dataStructure, const Arguments& filterArgs, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;

/**
* @brief Applies the filter's algorithm to the DataStructure with the given arguments. Returns any warnings/errors.
Expand All @@ -100,7 +100,8 @@ class ORIENTATIONANALYSIS_EXPORT FindAvgCAxesFilter : public IFilter
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
Result<> executeImpl(DataStructure& data, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
Result<> executeImpl(DataStructure& dataStructure, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler,
const std::atomic_bool& shouldCancel) const override;
};
} // namespace nx::core

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,8 @@ class ORIENTATIONANALYSIS_EXPORT FindAvgOrientationsFilter : public IFilter
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
Result<> executeImpl(DataStructure& data, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
Result<> executeImpl(DataStructure& dataStructure, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler,
const std::atomic_bool& shouldCancel) const override;
};
} // namespace nx::core

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ class ORIENTATIONANALYSIS_EXPORT FindBoundaryStrengthsFilter : public IFilter
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
PreflightResult preflightImpl(const DataStructure& ds, const Arguments& filterArgs, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
PreflightResult preflightImpl(const DataStructure& dataStructure, const Arguments& filterArgs, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;

/**
* @brief Applies the filter's algorithm to the DataStructure with the given arguments. Returns any warnings/errors.
Expand All @@ -103,7 +103,8 @@ class ORIENTATIONANALYSIS_EXPORT FindBoundaryStrengthsFilter : public IFilter
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
Result<> executeImpl(DataStructure& data, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
Result<> executeImpl(DataStructure& dataStructure, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler,
const std::atomic_bool& shouldCancel) const override;
};
} // namespace nx::core

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ class ORIENTATIONANALYSIS_EXPORT FindCAxisLocationsFilter : public IFilter
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
PreflightResult preflightImpl(const DataStructure& ds, const Arguments& filterArgs, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
PreflightResult preflightImpl(const DataStructure& dataStructure, const Arguments& filterArgs, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;

/**
* @brief Applies the filter's algorithm to the DataStructure with the given arguments. Returns any warnings/errors.
Expand All @@ -99,7 +99,8 @@ class ORIENTATIONANALYSIS_EXPORT FindCAxisLocationsFilter : public IFilter
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
Result<> executeImpl(DataStructure& data, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
Result<> executeImpl(DataStructure& dataStructure, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler,
const std::atomic_bool& shouldCancel) const override;
};
} // namespace nx::core

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ class ORIENTATIONANALYSIS_EXPORT FindFeatureNeighborCAxisMisalignmentsFilter : p
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
PreflightResult preflightImpl(const DataStructure& ds, const Arguments& filterArgs, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
PreflightResult preflightImpl(const DataStructure& dataStructure, const Arguments& filterArgs, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;

/**
* @brief Applies the filter's algorithm to the DataStructure with the given arguments. Returns any warnings/errors.
Expand All @@ -101,7 +101,8 @@ class ORIENTATIONANALYSIS_EXPORT FindFeatureNeighborCAxisMisalignmentsFilter : p
* @param messageHandler The MessageHandler object
* @return Returns a Result object with error or warning values if any of those occurred during execution of this function
*/
Result<> executeImpl(DataStructure& data, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler, const std::atomic_bool& shouldCancel) const override;
Result<> executeImpl(DataStructure& dataStructure, const Arguments& filterArgs, const PipelineFilter* pipelineNode, const MessageHandler& messageHandler,
const std::atomic_bool& shouldCancel) const override;
};
} // namespace nx::core

Expand Down
Loading

0 comments on commit e791714

Please sign in to comment.