Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create a Citation section for the README #456

Closed
thewtex opened this issue Jan 29, 2019 · 6 comments · Fixed by #1594
Closed

Create a Citation section for the README #456

thewtex opened this issue Jan 29, 2019 · 6 comments · Fixed by #1594
Labels
Good first issue A good issue for community members new to contributing type:Documentation Documentation improvement or change
Milestone
ITK v5.1rc02

Comments

@thewtex
Copy link
Member

thewtex commented Jan 29, 2019

Add a Citation section to the README. This section should explain how to cite ITK in journal articles.

CC: @bpaniagua
@thewtex thewtex added the type:Documentation Documentation improvement or change label Jan 29, 2019
@thewtex thewtex changed the title Create Citation section for the README Create a Citation section for the README Jan 29, 2019
@thewtex thewtex added this to the ITK v5.0rc02 milestone Feb 1, 2019
@jhlegarreta
Copy link
Member

This should be helpful:
https://itk.org/Wiki/ITK/FAQ#How_do_I_cite_the_use_of_ITK_in_a_publication.3F

I guess we still want ITK to be cited as recommended there. The page is outdated, though (third edition is not in press right now: fourth edition is out) 😟.

@thewtex
Copy link
Member Author

thewtex commented Feb 6, 2019

Yes, we should reference the original publication, The Software Guide, but also the update emphasizing progress and the project's focus on reproducible research and open science: https://www.frontiersin.org/articles/10.3389/fninf.2014.00013/full.

@jhlegarreta
Copy link
Member

May be we could use zenodo and add the corresponding file and badge to the README file instead of adding a section in the README file? Or in addition to?

@thewtex
Copy link
Member Author

thewtex commented Mar 24, 2019

Good idea. Since Zenodo is version-dependent, we should probably wait until ITK 5.0.0 to create a citation.

@jhlegarreta
Copy link
Member

Seems reasonable.

A few (possibly useful) thoughts:

  • GitHub Making Your Code Citable guide.
  • On second thoughts, even if zenodo is used, adding a Citing ITK section somewhere would still be necessary. The SW Guide could be a good place, but may be the README in the ITK repository is better.
  • Not sure if it the zenodo citation information could also be used in the PyPI ITK package.
  • Generating the zenodo citation every time a release is made should be added to Release.md.
  • Not sure whether a JSON with the repository/author information (nibabel script example) should be generated and uploaded using a script for example to zenodo.

We'll figure out.

@dzenanz dzenanz added the Good first issue A good issue for community members new to contributing label Apr 9, 2019
@thewtex thewtex modified the milestones: ITK v5.0rc02, ITK v5.0.0 Apr 12, 2019
@thewtex thewtex modified the milestones: ITK v5.0.0, ITK v5.1.0 May 10, 2019
@thewtex thewtex modified the milestones: ITK v5.1.0, ITK v5.1rc02 Dec 5, 2019
@munkm munkm mentioned this issue Jan 7, 2020
Closed
@thewtex
Copy link
Member Author

thewtex commented Jan 8, 2020

Zenodo badge added in #1540

thewtex added a commit to thewtex/ITK that referenced this issue Feb 6, 2020
@thewtex
DOC: Add Citation section to README
4082d7d 
Closes InsightSoftwareConsortium#456
thewtex added a commit to thewtex/ITK that referenced this issue Feb 6, 2020
@thewtex
DOC: Add Citation section to README
d362bc0 
Closes InsightSoftwareConsortium#456
@thewtex thewtex mentioned this issue Feb 6, 2020
Merged
@jhlegarreta jhlegarreta mentioned this issue Feb 8, 2020
Merged
hjmjohnson added a commit to hjmjohnson/ITK that referenced this issue Feb 12, 2020
@hjmjohnson
ENH: Consistently use strongly typed enums
517f1d4 
CHANGED:
  - AreaType to AreaEnum enum class
  - ConnectivityEnumType to ConnectivityEnum enum class
  - EdgeStatusType to EdgeStatusEnum enum class
  - GradientType to GradientEnum enum class
  - GrowthStrategyType to GrowthStrategyEnum enum class
  - GrowthStrategyType to GrowthStrategyEnum enum object
  - HashFunction to HashFunctionEnum enum class
  - Include Legacy_Remove parameters for backwards
  - InterpolationMethodType to InterpolationMethodEnum enum class
  - InterpolationModeType into InterpolationModeEnum enum class
  - LabelType to LabelEnum enum class
  - LeafIdentifier to LeafIdentifierEnum enum class
  - LineSearchMethod to LineSearchMethodEnum
  - LogLevel to LogLevelEnum enum class
  - MetricCategoryType to MetricCategoryEnum enum class
  - MetricSamplingStrategyType to MetricSamplingStrategyEnum
  - NoiseModelType to NoiseModelEnum enum object
  - OctreePlaneType to OctreePlaneEnum enum class
  - OctreePlaneType to OctreePlaneNode enum object
  - RegionType to RegionEnum enum class
  - SIDE to SIDEEnum enum class
  - SigmaStepMethodType to SigmanStepMethodEnum enum class
  - Sign to SignEnum enum class
  - StopConditionEnum to scoped enum class
  - TERMINATION_CODE to TERMINATION_CODE_ENUM enum class
  - TargetConditionType to TargetConditionEnum enum class
  - TemporalUnitType to TemporalUnitEnum enum class
  - TimeStampFormatType to TimeStampFormatEnum enum class
  - TopologyCheckType to TopologyCheckEnum enum class
  - TransformDirectionType to TransformDirectionEnum enum class
  - TraversalDirection to TraversalDirectionEnum enum class
  - WeightType to WeightEnum enum object
  - ConnectedThresholdImageFilterEnums/ -> ConnectivityEnum
  - QuadEdgeMeshEulerOperatorFlipEdgeFunctionEnums/EdgeStatusType -> EdgeStatusEnum
  - ObjectStoreEnums/GrowthStrategy -> GrowthStrategyEnum
  - HashImageFilterEnums/HashFunction -> HashFunctionEnum
  - CommonEnums
    + IOPixel -> IOPixelEnum
    + IOComponent -> IOComponentEnum
    + IOFile -> IOFileEnum
    + IOFileMode -> IOFileModeEnum
    + IOByteOrder -> IOByteOrderEnum
    + CellGeometry -> CellGeometryEnum
  - MeshEnums
    + MeshClassCellsAllocationMethod -> MeshClassCellsAllocationMethod
  - ContourSpatialObjectEnums/InterpolationMethod -> InterpolationMethodEnum
  - GaussianDerivateOperatorEnums/InterpolationMode -> InterpolationModeEnum
  - OctreeNodeEnums/LeafIdentifier -> LeafIdentifierEnum
  - LBFGS2Optimizerv4/LineSearchMethod -> LineSearchMethodEnum
  - DCMTKImageIOEnums/LogLevel -> LogLevelEnum
  - OctreeBaseEnums/Octree -> OctreeBaseEnums
  - RegionEnums/RegionEnum -> RegionEnum
  - FastMarchingTraitsEnum/TopologyCheck -> TopologyCheckEnum
  - LoggerBaseEnums/(PriorityLevel & TimeStampFormat) -> PriorityLevelEnum & TimeStampFormatEnum
  - TemporalDataObjectEnums/TemporalUnit -> TemporalUnitEnum
  - ComplexToComplexFFTImageFilterEnums/TransformDirection -> TransformDirectionEnum
  - ScalarToRGBColormapImageFilterEnums/RGBColormapFilter -> RGBColormapFilterEnum
  - FRPROptimizerEnums/Optimization -> Optimization
  - TreeIteratorBaseEnums/TreeIteratorBaseNode -> NodeType (NO TEST NEED NEW TEST)
  - FloatingPointExceptionsEnums/ExceptionAction -> ExceptionActionEnum
  - VideoIOFactoryEnums/IOMode -> IOModeEnum
  - FastMarchingreachedTargetNoesStoppingCriterionEnums/TargetCondition -> TargetConditionEnum
  - ObjectFactoryBaseEnums/InsertionPosition-> InsertionPositionEnums
  - HistogramToRunLengthFeaturesFilterEnums/RunLengthFeature -> RunLengthFeatureEnum
  - MultiThreaderBaseEnums/ThreadExitCode -> ThreadExitCodeEnum
  - MultiThreaderBaseEnums/Threader -> ThreadEnum
  - DTITibeSpatialObjectPointenums/DTITubeSpatialObjectPointField -> DTITubeSpatialObjectPointFieldEnum
  - ConvolutionImageFilterBaseEnums/ConvolutionImageFilterOutput -> ConvolutionImageFilterOutputEnum
  - ExtractSliceImageFilterEnums/TestExtractSliceImageFilterCollapseStrategy -> TestExtractSliceImageFilterCollapseStrategyEnum
  - PatchBasedDenoisingBaseImageFilterEnums/
    + NoiseModel -> NoiseModelEnum
    + ComponentSpace -> ComponentSpaceEnum
    + FilterState -> FilterStateEnum
  - DiffusionTensor3DReconstructionImageFilterEnums/GradientImageFormat -> GradientImageFormatEnum
  - GDCMImageIOEnums/Compression -> CompressionEnums
  - FastMarchingImageFilterEnums/Label -> LabelEnums
  - VideoIOBaseEnums/ReadFrom -> ReadFromEnum
  - ConnectThresholdImageFilterEnums/Connectivity -> ConnectivityEnum
  - DeformableSimplexMesh3DGradientConstraintForceFilter/SIDE -> SIDEEnum
  - ImageRegistrationMethodv4Enums/MetricSamplingStrategy -> MetricSamplingStrategyEnum
  - TransformBaseTemplateEnums/TransformCategory -> TransformCategoryEnums
  - MergeLabelMapFilterEnums/ChoiceMethod -> ChoiceMethodEnum
  - LaplacianDeformationQuadEdgeMeshFilterEnums/Area -> AreaEnum
  - IOCommonEnums/AtomicPixel -> AtomicPixelEnum
  - ESMDemonsRegistrationFunctionEnums/Gradient -> GradientEnum
  - RecursiveGaussianImageFilterEnums/GaussianOrder -> GaussianOrderEnum
  - SPSAOptimizerEnums/StopConditionSPSAOptimizer -> StopConditionSPSAOptimizerEnum
  - SymmetricEigenAnalysisEnums/EigenValueOrder -> EigenValueOrderEnum
  - ObjectToObjectMetricBaseTemplateEnums
    + GradientSource -> GradientSourceEnums
    + MetricCategory -> MetricCategoryEnums
  - ObjectToObjectOptimizerBaseTemplateEnums/StopConditionObjectToObjectOptimizer -> StopConditionObjectToObjectOptimizerEnum
  - RegistrationParameterScalesEstimatorEnums/SamplingStrategy -> SamplingStrategyEnum
  - HistogramToTextureFeaturesFilterEnums/TextureFeature -> TextureFeatureEnum
  - RayCasterHelperEnums/TraversalDirection -> TraversalDirectionEnum
  - CallRecordEnums/
    + RecordType -> RecoredEnum
    + MethodType -> MethodEnum
  - JPEG2000ImageIOInternalEnums/
    + DecodingFormat -> DecodingFormatEnum
    + DFMFormat -> DFMFormaType
  - FEMRegistrationFilterEnums/Sign -> SignEnum

CREATION:
  - new enum class ExceptionEnum
  - ExceptionActionEnum enum object
  - MetricSamplingStrategyEnum enum class (scoped)
  - Replace old static_cast with new itkExposeEnumValue to faciliate
    future refactorings

NEW NAMES: These enums have been consolidated so only one
           definition exists across the toolkit
  - Image/Mesh/Transform versions of FileEnum|FileModeEnum|ByteOrderEnum
    are now named IO(FileEnum|FileModeEnum|ByteOrderEnum) in itk namespace
  - CellGeometryEnum is moved to itk namespace to remove exact duplicate
    definitions in multiple modules (IO/Quadedgemesh/...)

NEW FILE:
EnumPrintFunction.py - creates a basic template of an ITKv5 enum class

Change some duplicate enum class names that have different values so
that they are uniquely named for their intended purpose.

Co-Authored by: Mathew J. Seng <mathewseng@gmail.com>
Co-Authored by: Matt McCormick <matt.mccormick@kitware.com>
Co-Authored by: Hans Johnson <hans-johnson@uiowa.edu>

commit d8879be
Author: Hans Johnson <hans-johnson@uiowa.edu>
Date:   Tue Feb 11 17:18:12 2020

    COMP: Need to explicitly define std::min<> template values

commit afacde6
Author: Hans Johnson <hans-johnson@uiowa.edu>
Date:   Tue Dec 31 11:47:42 2019

    STYLE: clang-format style updates.

commit 198a800
Author: Hans Johnson <hans-johnson@uiowa.edu>
Date:   Sat Feb 8 11:57:15 2020

    ENH: Update RTK for future proofing.

    Using explicit typecasts for futuree proofing
    enums.  RTK treats enum values as integers and
    eneumerations interchangibly for pushing onto
    a stack of integers.  Using explicit static_casts
    makes code future proof when enum class is used.

commit 486d3e8 (upstream/python-builds, upstream/nightly-master, upstream/master)
Merge: aa4e759 f0dde80
Author: Matt McCormick <matt.mccormick@kitware.com>
Date:   Tue Feb 11 15:50:36 2020

    Merge pull request InsightSoftwareConsortium#1604 from thewtex/contributor-welcome

    DOC: Add welcome message to CONTRIBUTING.md

commit f0dde80
Author: Matt McCormick <matt.mccormick@kitware.com>
Date:   Tue Feb 11 14:49:46 2020

    DOC: Add welcome message to CONTRIBUTING.md

    Scraped from https://github.com/nipy/nibabel/blob/master/.github/CONTRIBUTING.md

commit aa4e759
Merge: 102c3ed 344e9bc
Author: Matt McCormick <matt.mccormick@kitware.com>
Date:   Tue Feb 11 12:07:27 2020

    Merge pull request InsightSoftwareConsortium#1598 from thewtex/numfocus-copyright

    DOC: Update copyright assignment to NumFOCUS

commit 102c3ed
Author: Dženan Zukić <dzenan.zukic@kitware.com>
Date:   Mon Feb 10 10:41:11 2020

    BUG: remove assertion which frequently fails

    We are not checking difference along dimension zero,
    so it is possible for diffSum to be 0 despite neighbors being different.

    This is a follow-up to c32a784.

commit 3f232f7
Author: Hans Johnson <hans-johnson@uiowa.edu>
Date:   Sat Feb 8 13:27:29 2020

    BUG: operator() can not be const

    The member variable is changed, so the operator() can not be const.

commit 94769e0 (origin/master, origin/HEAD)
Author: Vladimir S. FONOV <vladimir.fonov@gmail.com>
Date:   Mon Feb 3 13:33:14 2020

    DOC: updated ITK5MigrationGuide on Analyze format support

commit 14851ac
Author: Bradley Lowekamp <blowekamp@mail.nih.gov>
Date:   Fri Feb 7 10:25:29 2020

    BUG: Restore enum typedef name Convolution and Deconvolution filters

commit da0e395
Merge: abcd10b 305fc77
Author: Matt McCormick <matt.mccormick@kitware.com>
Date:   Fri Feb 7 14:02:00 2020

    Merge pull request InsightSoftwareConsortium#1596 from DVigneault/BumpCuberilleCommitHash

    BUG: Bump Cuberille Commit Hash

commit 344e9bc (thewtex/numfocus-copyright)
Author: Matt McCormick <matt.mccormick@kitware.com>
Date:   Fri Feb 7 13:23:51 2020

    DOC: Update copyright assignment to NumFOCUS

    As part of the process of the Insight Software Consortium joining the
    NumFOCUS non-profit corporation as a Fiscally Sponsored Project, all
    assets, including intellectual property assets, are being transferred to
    enable dissolution of the Insight Software Consortium non-profit
    corporate legal entity.

    The Insight Software Consortium Board of Directors resolved in the
    2019-10-22 Meeting to assign ITK copyright to NumFOCUS and CMake and
    IGSTK to Kitware. A copy of the signed copyright transfer documents is
    attached to this pull request.

commit 305fc77
Author: Davis Vigneault <davis.vigneault@gmail.com>
Date:   Fri Feb 7 12:38:06 2020

    BUG: Bump Cuberille Commit Hash

    Recent patches to ITKCuberille have addressed a longstanding issue
    which caused failures when generating itk::QuadEdgeMesh objects.
    This commit updates the git commit hash, bringing this bugfix into
    the master branch if ITK.

commit abcd10b
Merge: e138b60 f93f025
Author: Matt McCormick <matt.mccormick@kitware.com>
Date:   Fri Feb 7 12:42:31 2020

    Merge pull request InsightSoftwareConsortium#1594 from thewtex/readme-citation-section

    DOC: Add Citation section to README

commit f93f025
Author: Matt McCormick <matt.mccormick@kitware.com>
Date:   Thu Feb 6 15:38:21 2020

    DOC: Request updates ITKBibliography.bib

commit d362bc0
Author: Matt McCormick <matt.mccormick@kitware.com>
Date:   Thu Feb 6 15:23:55 2020

    DOC: Add Citation section to README

    Closes InsightSoftwareConsortium#456

commit e138b60 (thewtex/master)
Merge: c32a784 5d1ba7f
Author: Matt McCormick <matt.mccormick@kitware.com>
Date:   Tue Feb 4 18:33:12 2020

    Merge pull request InsightSoftwareConsortium#1591 from nocnokneo/OpenCV4

    COMP: Fix unit tests for OpenCV 4

commit c32a784
Author: Dženan Zukić <dzenan.zukic@kitware.com>
Date:   Mon Feb 3 11:04:15 2020

    BUG: incorrect neighbor determination in scan-line derived filters

    Thanks to @DVigneault for finding the bug and creating a MWE to demonstrate it

commit 5671480
Merge: e0262df cb2bec6
Author: Matt McCormick <matt.mccormick@kitware.com>
Date:   Mon Feb 3 15:46:51 2020

    Merge pull request InsightSoftwareConsortium#1582 from thewtex/itk-python-filter-downcast

    BUG: Call itk.down_cast on ProcessObject outputs in functional call
hjmjohnson added a commit to thewtex/ITK that referenced this issue Feb 12, 2020
@hjmjohnson
ENH: Consistently use strongly typed enums
c1c4c7c 
CHANGED:
  - AreaType to AreaEnum enum class
  - ConnectivityEnumType to ConnectivityEnum enum class
  - EdgeStatusType to EdgeStatusEnum enum class
  - GradientType to GradientEnum enum class
  - GrowthStrategyType to GrowthStrategyEnum enum class
  - GrowthStrategyType to GrowthStrategyEnum enum object
  - HashFunction to HashFunctionEnum enum class
  - Include Legacy_Remove parameters for backwards
  - InterpolationMethodType to InterpolationMethodEnum enum class
  - InterpolationModeType into InterpolationModeEnum enum class
  - LabelType to LabelEnum enum class
  - LeafIdentifier to LeafIdentifierEnum enum class
  - LineSearchMethod to LineSearchMethodEnum
  - LogLevel to LogLevelEnum enum class
  - MetricCategoryType to MetricCategoryEnum enum class
  - MetricSamplingStrategyType to MetricSamplingStrategyEnum
  - NoiseModelType to NoiseModelEnum enum object
  - OctreePlaneType to OctreePlaneEnum enum class
  - OctreePlaneType to OctreePlaneNode enum object
  - RegionType to RegionEnum enum class
  - SIDE to SIDEEnum enum class
  - SigmaStepMethodType to SigmanStepMethodEnum enum class
  - Sign to SignEnum enum class
  - StopConditionEnum to scoped enum class
  - TERMINATION_CODE to TERMINATION_CODE_ENUM enum class
  - TargetConditionType to TargetConditionEnum enum class
  - TemporalUnitType to TemporalUnitEnum enum class
  - TimeStampFormatType to TimeStampFormatEnum enum class
  - TopologyCheckType to TopologyCheckEnum enum class
  - TransformDirectionType to TransformDirectionEnum enum class
  - TraversalDirection to TraversalDirectionEnum enum class
  - WeightType to WeightEnum enum object
  - ConnectedThresholdImageFilterEnums/ -> ConnectivityEnum
  - QuadEdgeMeshEulerOperatorFlipEdgeFunctionEnums/EdgeStatusType -> EdgeStatusEnum
  - ObjectStoreEnums/GrowthStrategy -> GrowthStrategyEnum
  - HashImageFilterEnums/HashFunction -> HashFunctionEnum
  - CommonEnums
    + IOPixel -> IOPixelEnum
    + IOComponent -> IOComponentEnum
    + IOFile -> IOFileEnum
    + IOFileMode -> IOFileModeEnum
    + IOByteOrder -> IOByteOrderEnum
    + CellGeometry -> CellGeometryEnum
  - MeshEnums
    + MeshClassCellsAllocationMethod -> MeshClassCellsAllocationMethod
  - ContourSpatialObjectEnums/InterpolationMethod -> InterpolationMethodEnum
  - GaussianDerivateOperatorEnums/InterpolationMode -> InterpolationModeEnum
  - OctreeNodeEnums/LeafIdentifier -> LeafIdentifierEnum
  - LBFGS2Optimizerv4/LineSearchMethod -> LineSearchMethodEnum
  - DCMTKImageIOEnums/LogLevel -> LogLevelEnum
  - OctreeBaseEnums/Octree -> OctreeBaseEnums
  - RegionEnums/RegionEnum -> RegionEnum
  - FastMarchingTraitsEnum/TopologyCheck -> TopologyCheckEnum
  - LoggerBaseEnums/(PriorityLevel & TimeStampFormat) -> PriorityLevelEnum & TimeStampFormatEnum
  - TemporalDataObjectEnums/TemporalUnit -> TemporalUnitEnum
  - ComplexToComplexFFTImageFilterEnums/TransformDirection -> TransformDirectionEnum
  - ScalarToRGBColormapImageFilterEnums/RGBColormapFilter -> RGBColormapFilterEnum
  - FRPROptimizerEnums/Optimization -> Optimization
  - TreeIteratorBaseEnums/TreeIteratorBaseNode -> NodeType (NO TEST NEED NEW TEST)
  - FloatingPointExceptionsEnums/ExceptionAction -> ExceptionActionEnum
  - VideoIOFactoryEnums/IOMode -> IOModeEnum
  - FastMarchingreachedTargetNoesStoppingCriterionEnums/TargetCondition -> TargetConditionEnum
  - ObjectFactoryBaseEnums/InsertionPosition-> InsertionPositionEnums
  - HistogramToRunLengthFeaturesFilterEnums/RunLengthFeature -> RunLengthFeatureEnum
  - MultiThreaderBaseEnums/ThreadExitCode -> ThreadExitCodeEnum
  - MultiThreaderBaseEnums/Threader -> ThreadEnum
  - DTITibeSpatialObjectPointenums/DTITubeSpatialObjectPointField -> DTITubeSpatialObjectPointFieldEnum
  - ConvolutionImageFilterBaseEnums/ConvolutionImageFilterOutput -> ConvolutionImageFilterOutputEnum
  - ExtractSliceImageFilterEnums/TestExtractSliceImageFilterCollapseStrategy -> TestExtractSliceImageFilterCollapseStrategyEnum
  - PatchBasedDenoisingBaseImageFilterEnums/
    + NoiseModel -> NoiseModelEnum
    + ComponentSpace -> ComponentSpaceEnum
    + FilterState -> FilterStateEnum
  - DiffusionTensor3DReconstructionImageFilterEnums/GradientImageFormat -> GradientImageFormatEnum
  - GDCMImageIOEnums/Compression -> CompressionEnums
  - FastMarchingImageFilterEnums/Label -> LabelEnums
  - VideoIOBaseEnums/ReadFrom -> ReadFromEnum
  - ConnectThresholdImageFilterEnums/Connectivity -> ConnectivityEnum
  - DeformableSimplexMesh3DGradientConstraintForceFilter/SIDE -> SIDEEnum
  - ImageRegistrationMethodv4Enums/MetricSamplingStrategy -> MetricSamplingStrategyEnum
  - TransformBaseTemplateEnums/TransformCategory -> TransformCategoryEnums
  - MergeLabelMapFilterEnums/ChoiceMethod -> ChoiceMethodEnum
  - LaplacianDeformationQuadEdgeMeshFilterEnums/Area -> AreaEnum
  - IOCommonEnums/AtomicPixel -> AtomicPixelEnum
  - ESMDemonsRegistrationFunctionEnums/Gradient -> GradientEnum
  - RecursiveGaussianImageFilterEnums/GaussianOrder -> GaussianOrderEnum
  - SPSAOptimizerEnums/StopConditionSPSAOptimizer -> StopConditionSPSAOptimizerEnum
  - SymmetricEigenAnalysisEnums/EigenValueOrder -> EigenValueOrderEnum
  - ObjectToObjectMetricBaseTemplateEnums
    + GradientSource -> GradientSourceEnums
    + MetricCategory -> MetricCategoryEnums
  - ObjectToObjectOptimizerBaseTemplateEnums/StopConditionObjectToObjectOptimizer -> StopConditionObjectToObjectOptimizerEnum
  - RegistrationParameterScalesEstimatorEnums/SamplingStrategy -> SamplingStrategyEnum
  - HistogramToTextureFeaturesFilterEnums/TextureFeature -> TextureFeatureEnum
  - RayCasterHelperEnums/TraversalDirection -> TraversalDirectionEnum
  - CallRecordEnums/
    + RecordType -> RecoredEnum
    + MethodType -> MethodEnum
  - JPEG2000ImageIOInternalEnums/
    + DecodingFormat -> DecodingFormatEnum
    + DFMFormat -> DFMFormaType
  - FEMRegistrationFilterEnums/Sign -> SignEnum

CREATION:
  - new enum class ExceptionEnum
  - ExceptionActionEnum enum object
  - MetricSamplingStrategyEnum enum class (scoped)
  - Replace old static_cast with new itkExposeEnumValue to faciliate
    future refactorings

NEW NAMES: These enums have been consolidated so only one
           definition exists across the toolkit
  - Image/Mesh/Transform versions of FileEnum|FileModeEnum|ByteOrderEnum
    are now named IO(FileEnum|FileModeEnum|ByteOrderEnum) in itk namespace
  - CellGeometryEnum is moved to itk namespace to remove exact duplicate
    definitions in multiple modules (IO/Quadedgemesh/...)

NEW FILE:
EnumPrintFunction.py - creates a basic template of an ITKv5 enum class

Change some duplicate enum class names that have different values so
that they are uniquely named for their intended purpose.

Co-Authored by: Mathew J. Seng <mathewseng@gmail.com>
Co-Authored by: Matt McCormick <matt.mccormick@kitware.com>
Co-Authored by: Hans Johnson <hans-johnson@uiowa.edu>

commit d8879be
Author: Hans Johnson <hans-johnson@uiowa.edu>
Date:   Tue Feb 11 17:18:12 2020

    COMP: Need to explicitly define std::min<> template values

commit afacde6
Author: Hans Johnson <hans-johnson@uiowa.edu>
Date:   Tue Dec 31 11:47:42 2019

    STYLE: clang-format style updates.

commit 198a800
Author: Hans Johnson <hans-johnson@uiowa.edu>
Date:   Sat Feb 8 11:57:15 2020

    ENH: Update RTK for future proofing.

    Using explicit typecasts for futuree proofing
    enums.  RTK treats enum values as integers and
    eneumerations interchangibly for pushing onto
    a stack of integers.  Using explicit static_casts
    makes code future proof when enum class is used.

commit 486d3e8 (upstream/python-builds, upstream/nightly-master, upstream/master)
Merge: aa4e759 f0dde80
Author: Matt McCormick <matt.mccormick@kitware.com>
Date:   Tue Feb 11 15:50:36 2020

    Merge pull request InsightSoftwareConsortium#1604 from thewtex/contributor-welcome

    DOC: Add welcome message to CONTRIBUTING.md

commit f0dde80
Author: Matt McCormick <matt.mccormick@kitware.com>
Date:   Tue Feb 11 14:49:46 2020

    DOC: Add welcome message to CONTRIBUTING.md

    Scraped from https://github.com/nipy/nibabel/blob/master/.github/CONTRIBUTING.md

commit aa4e759
Merge: 102c3ed 344e9bc
Author: Matt McCormick <matt.mccormick@kitware.com>
Date:   Tue Feb 11 12:07:27 2020

    Merge pull request InsightSoftwareConsortium#1598 from thewtex/numfocus-copyright

    DOC: Update copyright assignment to NumFOCUS

commit 102c3ed
Author: Dženan Zukić <dzenan.zukic@kitware.com>
Date:   Mon Feb 10 10:41:11 2020

    BUG: remove assertion which frequently fails

    We are not checking difference along dimension zero,
    so it is possible for diffSum to be 0 despite neighbors being different.

    This is a follow-up to c32a784.

commit 3f232f7
Author: Hans Johnson <hans-johnson@uiowa.edu>
Date:   Sat Feb 8 13:27:29 2020

    BUG: operator() can not be const

    The member variable is changed, so the operator() can not be const.

commit 94769e0 (origin/master, origin/HEAD)
Author: Vladimir S. FONOV <vladimir.fonov@gmail.com>
Date:   Mon Feb 3 13:33:14 2020

    DOC: updated ITK5MigrationGuide on Analyze format support

commit 14851ac
Author: Bradley Lowekamp <blowekamp@mail.nih.gov>
Date:   Fri Feb 7 10:25:29 2020

    BUG: Restore enum typedef name Convolution and Deconvolution filters

commit da0e395
Merge: abcd10b 305fc77
Author: Matt McCormick <matt.mccormick@kitware.com>
Date:   Fri Feb 7 14:02:00 2020

    Merge pull request InsightSoftwareConsortium#1596 from DVigneault/BumpCuberilleCommitHash

    BUG: Bump Cuberille Commit Hash

commit 344e9bc (thewtex/numfocus-copyright)
Author: Matt McCormick <matt.mccormick@kitware.com>
Date:   Fri Feb 7 13:23:51 2020

    DOC: Update copyright assignment to NumFOCUS

    As part of the process of the Insight Software Consortium joining the
    NumFOCUS non-profit corporation as a Fiscally Sponsored Project, all
    assets, including intellectual property assets, are being transferred to
    enable dissolution of the Insight Software Consortium non-profit
    corporate legal entity.

    The Insight Software Consortium Board of Directors resolved in the
    2019-10-22 Meeting to assign ITK copyright to NumFOCUS and CMake and
    IGSTK to Kitware. A copy of the signed copyright transfer documents is
    attached to this pull request.

commit 305fc77
Author: Davis Vigneault <davis.vigneault@gmail.com>
Date:   Fri Feb 7 12:38:06 2020

    BUG: Bump Cuberille Commit Hash

    Recent patches to ITKCuberille have addressed a longstanding issue
    which caused failures when generating itk::QuadEdgeMesh objects.
    This commit updates the git commit hash, bringing this bugfix into
    the master branch if ITK.

commit abcd10b
Merge: e138b60 f93f025
Author: Matt McCormick <matt.mccormick@kitware.com>
Date:   Fri Feb 7 12:42:31 2020

    Merge pull request InsightSoftwareConsortium#1594 from thewtex/readme-citation-section

    DOC: Add Citation section to README

commit f93f025
Author: Matt McCormick <matt.mccormick@kitware.com>
Date:   Thu Feb 6 15:38:21 2020

    DOC: Request updates ITKBibliography.bib

commit d362bc0
Author: Matt McCormick <matt.mccormick@kitware.com>
Date:   Thu Feb 6 15:23:55 2020

    DOC: Add Citation section to README

    Closes InsightSoftwareConsortium#456

commit e138b60 (thewtex/master)
Merge: c32a784 5d1ba7f
Author: Matt McCormick <matt.mccormick@kitware.com>
Date:   Tue Feb 4 18:33:12 2020

    Merge pull request InsightSoftwareConsortium#1591 from nocnokneo/OpenCV4

    COMP: Fix unit tests for OpenCV 4

commit c32a784
Author: Dženan Zukić <dzenan.zukic@kitware.com>
Date:   Mon Feb 3 11:04:15 2020

    BUG: incorrect neighbor determination in scan-line derived filters

    Thanks to @DVigneault for finding the bug and creating a MWE to demonstrate it

commit 5671480
Merge: e0262df cb2bec6
Author: Matt McCormick <matt.mccormick@kitware.com>
Date:   Mon Feb 3 15:46:51 2020

    Merge pull request InsightSoftwareConsortium#1582 from thewtex/itk-python-filter-downcast

    BUG: Call itk.down_cast on ProcessObject outputs in functional call
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Good first issue A good issue for community members new to contributing type:Documentation Documentation improvement or change
Projects
None yet
Milestone
ITK v5.1rc02
Development

Successfully merging a pull request may close this issue.

DOC: Add Citation section to README thewtex/ITK
3 participants
@thewtex @dzenanz @jhlegarreta