 |
ITK 6.0.0
Insight Toolkit
|
|
|
ITK 6.0.0
Insight Toolkit
|
|
#include <itkShotNoiseImageFilter.h>
Alter an image with shot noise.
The shot noise follows a Poisson distribution:
The intensities in the image can be scaled by a user provided value to map pixel values to the actual number of particles. The scaling can be seen as the inverse of the gain used during the acquisition. The noisy signal is then scaled back to its input intensity range:
The Poisson-distributed variable \( \lambda \) is computed by using the algorithm:
This algorithm is very inefficient for large values of \( \lambda \), though. Fortunately, the Poisson distribution can be accurately approximated by a Gaussian distribution of mean and variance \( \lambda \) when \( \lambda \) is large enough. In this implementation, this value is considered to be 50. This leads to the faster algorithm:
This code was contributed in the Insight Journal paper "Noise Simulation". https://doi.org/10.54294/vh6vbw
Definition at line 94 of file itkShotNoiseImageFilter.h.
Inheritance diagram for itk::ShotNoiseImageFilter< TInputImage, TOutputImage >: Collaboration diagram for itk::ShotNoiseImageFilter< TInputImage, TOutputImage >:Public Member Functions | |
| virtual::itk::LightObject::Pointer | CreateAnother () const |
| const char * | GetNameOfClass () const override |
| virtual double | GetScale () const |
| virtual void | SetScale (double _arg) |
| Public Member Functions inherited from itk::NoiseBaseImageFilter< TInputImage, TInputImage > | |
| virtual void | SetSeed () |
| virtual uint32_t | GetSeed () const |
| virtual void | SetSeed (uint32_t _arg) |
| Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TInputImage > | |
| virtual bool | CanRunInPlace () const |
| virtual void | SetInPlace (bool _arg) |
| virtual bool | GetInPlace () const |
| virtual void | InPlaceOn () |
| virtual void | InPlaceOff () |
| Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage > | |
| const InputImageType * | GetInput () const |
| const InputImageType * | GetInput () const |
| const InputImageType * | GetInput (unsigned int idx) const |
| const InputImageType * | GetInput (unsigned int idx) const |
| void | PopBackInput () override |
| void | PopBackInput () override |
| void | PopFrontInput () override |
| void | PopFrontInput () override |
| virtual void | PushBackInput (const InputImageType *input) |
| virtual void | PushBackInput (const InputImageType *input) |
| virtual void | PushFrontInput (const InputImageType *input) |
| virtual void | PushFrontInput (const InputImageType *input) |
| virtual void | SetInput (const InputImageType *input) |
| virtual void | SetInput (const InputImageType *input) |
| virtual void | SetInput (unsigned int, const TInputImage *image) |
| virtual void | SetInput (unsigned int, const TInputImage *image) |
| virtual void | SetCoordinateTolerance (double _arg) |
| virtual double | GetCoordinateTolerance () const |
| virtual void | SetCoordinateTolerance (double _arg) |
| virtual double | GetCoordinateTolerance () const |
| virtual void | SetDirectionTolerance (double _arg) |
| virtual double | GetDirectionTolerance () const |
| virtual void | SetDirectionTolerance (double _arg) |
| virtual double | GetDirectionTolerance () const |
| Public Member Functions inherited from itk::ImageSource< TInputImage > | |
| OutputImageType * | GetOutput (unsigned int idx) |
| OutputImageType * | GetOutput () |
| const OutputImageType * | GetOutput () const |
| virtual void | GraftOutput (DataObject *graft) |
| virtual void | GraftOutput (const DataObjectIdentifierType &key, DataObject *graft) |
| virtual void | GraftNthOutput (unsigned int idx, DataObject *graft) |
| ProcessObject::DataObjectPointer | MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override |
| ProcessObject::DataObjectPointer | MakeOutput (const ProcessObject::DataObjectIdentifierType &) override |
| Public Member Functions inherited from itk::ProcessObject | |
| virtual void | AbortGenerateDataOff () |
| virtual void | AbortGenerateDataOn () |
| virtual void | EnlargeOutputRequestedRegion (DataObject *output) |
| virtual const bool & | GetAbortGenerateData () const |
| DataObjectPointerArray | GetIndexedInputs () |
| DataObjectPointerArray | GetIndexedOutputs () |
| NameArray | GetInputNames () const |
| DataObjectPointerArray | GetInputs () |
| MultiThreaderType * | GetMultiThreader () const |
| DataObjectPointerArraySizeType | GetNumberOfIndexedInputs () const |
| DataObjectPointerArraySizeType | GetNumberOfIndexedOutputs () const |
| DataObjectPointerArraySizeType | GetNumberOfInputs () const |
| DataObjectPointerArraySizeType | GetNumberOfOutputs () const |
| virtual DataObjectPointerArraySizeType | GetNumberOfValidRequiredInputs () const |
| NameArray | GetOutputNames () const |
| DataObjectPointerArray | GetOutputs () |
| virtual float | GetProgress () const |
| NameArray | GetRequiredInputNames () const |
| bool | HasInput (const DataObjectIdentifierType &key) const |
| bool | HasOutput (const DataObjectIdentifierType &key) const |
| void | IncrementProgress (float increment) |
| virtual void | PrepareOutputs () |
| virtual void | PropagateRequestedRegion (DataObject *output) |
| virtual void | ResetPipeline () |
| virtual void | SetAbortGenerateData (bool _arg) |
| void | SetMultiThreader (MultiThreaderType *threader) |
| virtual void | Update () |
| virtual void | UpdateLargestPossibleRegion () |
| virtual void | UpdateOutputData (DataObject *output) |
| virtual void | UpdateOutputInformation () |
| void | UpdateProgress (float progress) |
| virtual void | SetReleaseDataFlag (bool val) |
| virtual bool | GetReleaseDataFlag () const |
| void | ReleaseDataFlagOn () |
| void | ReleaseDataFlagOff () |
| virtual void | SetReleaseDataBeforeUpdateFlag (bool _arg) |
| virtual const bool & | GetReleaseDataBeforeUpdateFlag () const |
| virtual void | ReleaseDataBeforeUpdateFlagOn () |
| virtual void | ReleaseDataBeforeUpdateFlagOff () |
| virtual void | SetNumberOfWorkUnits (ThreadIdType _arg) |
| virtual const ThreadIdType & | GetNumberOfWorkUnits () const |
| Public Member Functions inherited from itk::Object | |
| unsigned long | AddObserver (const EventObject &event, Command *cmd) const |
| unsigned long | AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const |
| virtual void | DebugOff () const |
| virtual void | DebugOn () const |
| Command * | GetCommand (unsigned long tag) |
| bool | GetDebug () const |
| MetaDataDictionary & | GetMetaDataDictionary () |
| const MetaDataDictionary & | GetMetaDataDictionary () const |
| virtual ModifiedTimeType | GetMTime () const |
| virtual const TimeStamp & | GetTimeStamp () const |
| bool | HasObserver (const EventObject &event) const |
| void | InvokeEvent (const EventObject &) |
| void | InvokeEvent (const EventObject &) const |
| virtual void | Modified () const |
| void | Register () const override |
| void | RemoveAllObservers () |
| void | RemoveObserver (unsigned long tag) const |
| void | SetDebug (bool debugFlag) const |
| void | SetReferenceCount (int) override |
| void | UnRegister () const noexcept override |
| void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
| void | SetMetaDataDictionary (MetaDataDictionary &&rrhs) |
| virtual void | SetObjectName (std::string _arg) |
| virtual const std::string & | GetObjectName () const |
| Public Member Functions inherited from itk::LightObject | |
| Pointer | Clone () const |
| virtual void | Delete () |
| virtual int | GetReferenceCount () const |
| void | Print (std::ostream &os, Indent indent=0) const |
Static Public Member Functions | |
| static Pointer | New () |
| Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage > | |
| static double | GetGlobalDefaultCoordinateTolerance () |
| static double | GetGlobalDefaultCoordinateTolerance () |
| static double | GetGlobalDefaultDirectionTolerance () |
| static double | GetGlobalDefaultDirectionTolerance () |
| static void | SetGlobalDefaultCoordinateTolerance (double) |
| static void | SetGlobalDefaultCoordinateTolerance (double) |
| static void | SetGlobalDefaultDirectionTolerance (double) |
| static void | SetGlobalDefaultDirectionTolerance (double) |
| Static Public Member Functions inherited from itk::Object | |
| static bool | GetGlobalWarningDisplay () |
| static void | GlobalWarningDisplayOff () |
| static void | GlobalWarningDisplayOn () |
| static Pointer | New () |
| static void | SetGlobalWarningDisplay (bool val) |
| Static Public Member Functions inherited from itk::LightObject | |
| static void | BreakOnError () |
| static Pointer | New () |
Private Attributes | |
| double | m_Scale { 1.0 } |
Additional Inherited Members | |
| Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TInputImage > | |
| static constexpr unsigned int | InputImageDimension |
| static constexpr unsigned int | OutputImageDimension |
| Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TInputImage > | |
| static constexpr unsigned int | InputImageDimension |
| static constexpr unsigned int | InputImageDimension |
| static constexpr unsigned int | OutputImageDimension |
| static constexpr unsigned int | OutputImageDimension |
| Static Public Attributes inherited from itk::ImageSource< TInputImage > | |
| static constexpr unsigned int | OutputImageDimension |
| Protected Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage > | |
| using | InputToOutputRegionCopierType |
| using | OutputToInputRegionCopierType |
| Static Protected Member Functions inherited from itk::NoiseBaseImageFilter< TInputImage, TInputImage > | |
| static OutputImagePixelType | ClampCast (const double value) |
| static uint32_t | Hash (uint32_t a, uint32_t b) |
| Static Protected Member Functions inherited from itk::ImageSource< TInputImage > | |
| static const ImageRegionSplitterBase * | GetGlobalDefaultSplitter () |
| static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION | ThreaderCallback (void *arg) |
| Static Protected Member Functions inherited from itk::ProcessObject | |
| template<typename TSourceObject> | |
| static void | MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs) |
| static constexpr float | progressFixedToFloat (uint32_t fixed) |
| static uint32_t | progressFloatToFixed (float f) |
| Protected Attributes inherited from itk::ImageSource< TInputImage > | |
| bool | m_DynamicMultiThreading |
| Protected Attributes inherited from itk::ProcessObject | |
| TimeStamp | m_OutputInformationMTime {} |
| bool | m_Updating {} |
| Protected Attributes inherited from itk::LightObject | |
| std::atomic< int > | m_ReferenceCount {} |
| using itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self> |
Definition at line 104 of file itkShotNoiseImageFilter.h.
| using itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::InputImageConstPointer = typename InputImageType::ConstPointer |
Definition at line 121 of file itkShotNoiseImageFilter.h.
| using itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::InputImagePixelType = typename InputImageType::PixelType |
Definition at line 123 of file itkShotNoiseImageFilter.h.
| using itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::InputImagePointer = typename InputImageType::Pointer |
Definition at line 120 of file itkShotNoiseImageFilter.h.
| using itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::InputImageRegionType = typename InputImageType::RegionType |
Definition at line 122 of file itkShotNoiseImageFilter.h.
| using itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage |
Some convenient type alias.
Definition at line 119 of file itkShotNoiseImageFilter.h.
| using itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self> |
Definition at line 103 of file itkShotNoiseImageFilter.h.
| using itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::Self = ShotNoiseImageFilter |
Standard class type aliases.
Definition at line 101 of file itkShotNoiseImageFilter.h.
| using itk::ShotNoiseImageFilter< TInputImage, TOutputImage >::Superclass = NoiseBaseImageFilter<TInputImage, TOutputImage> |
Definition at line 102 of file itkShotNoiseImageFilter.h.
|
protected |
Referenced by GetNameOfClass().
|
overrideprotecteddefault |
|
virtual |
Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.
Reimplemented from itk::Object.
|
overridevirtual |
Reimplemented from itk::NoiseBaseImageFilter< TInputImage, TInputImage >.
References ShotNoiseImageFilter().
|
virtual |
Set/Get the value to map the pixel value to the actual particle counting. The scaling can be seen as the inverse of the gain used during the acquisition. The noisy signal is then scaled back to its input intensity range. Defaults to 1.0.
|
static |
Method for creation through the object factory.
|
overrideprotectedvirtual |
Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from itk::NoiseBaseImageFilter< TInputImage, TInputImage >.
|
virtual |
Set/Get the value to map the pixel value to the actual particle counting. The scaling can be seen as the inverse of the gain used during the acquisition. The noisy signal is then scaled back to its input intensity range. Defaults to 1.0.
|
overrideprotectedvirtual |
If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData() or DynamicThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call (Dynamic)ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of (Dynamic)ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a (Dynamic)ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The (Dynamic)ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. (Dynamic)ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).
DynamicThreadedGenerateData() is the newer variant without threadId, and is the preferred signature, which is called by default. This variant can split the requested region into different number of pieces depending on current multi-processing load, which allows better load balancing. The non-dynamic (also known as classic) ThreadedGenerateData() signature has threadId, and number of pieces to be split into is known in advance. It is activated by calling this->DynamicMultiThreadingOff(); in derived class constructor. It should be used when the multi-threaded algorithm needs to pre-allocate some data structure with size dependent on the number of pieces (also known as chunks, work units, and sometimes also incorrectly as threads). Only PlatformMultiThreader guarantees that each piece will be processed in its own specific thread. Pool and TBB multi-threaders maintain a pool of threads (normally equal to number of processing cores) which they use to process the pieces. This normally results in a single thread being reused to process multiple work units.
Reimplemented from itk::ImageSource< TInputImage >.
|
private |
Definition at line 148 of file itkShotNoiseImageFilter.h.
1.13.2