Skip to content

phase_degPhaseDegPhaseDegphase_degphase_deg🔗

Short description🔗

phase_degPhaseDegPhaseDegphase_degphase_deg — Return the phase of a complex image in degrees.

Signature🔗

phase_deg( image ImageComplex, out image ImagePhase )void PhaseDeg( const HObject& ImageComplex, HObject* ImagePhase )static void HOperatorSet.PhaseDeg( HObject imageComplex, out HObject imagePhase )def phase_deg( image_complex: HObject ) -> HObject

Herror phase_deg( const Hobject ImageComplex, Hobject* ImagePhase )

Herror T_phase_deg( const Hobject ImageComplex, Hobject* ImagePhase )

HImage HImage::PhaseDeg( ) const

HImage HImage.PhaseDeg( )

Description🔗

phase_degPhaseDeg computes the phase of a complex image in degrees. The following formula is used:

\[\begin{eqnarray*} \textit{phase} = \frac{90}{\pi} \textrm{atan2}(\textit{imaginary part},\textit{real part}) \enspace . \end{eqnarray*}\]

Hence, ImagePhaseimagePhaseimage_phase contains half the phase angle. For negative phase angles, 180 is added.

Execution information🔗

Execution information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Automatically parallelized on tuple level.

  • Automatically parallelized on channel level.

  • Automatically parallelized on domain level.

Parameters🔗

ImageCompleximageCompleximage_complex (input_object) (multichannel-)image(-array) → object (complex)HObject (complex)HImage (complex)HObject (complex)Hobject (complex)

Input image in frequency domain.

ImagePhaseimagePhaseimage_phase (output_object) image(-array) → object (direction)HObject (direction)HImage (direction)HObject (direction)Hobject * (direction)

Phase of the image in degrees.

Example🔗

(C)

read_image(&Image,"monkey")\;
disp_image(Image,WindowHandle)\;
fft_image(Image,&FFT)\;
phase_deg(FFT,&Phase)\;
disp_image(Phase,WindowHandle)\;

Result🔗

phase_degPhaseDeg returns 2 (H_MSG_TRUE) if the image is of correct type. If the input is empty the behavior can be set via set_system(::'no_object_result',<Result>:). If necessary, an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

fft_imageFftImage, fft_genericFftGeneric, rft_genericRftGeneric

Possible successors

disp_imageDispImage

Alternatives

phase_radPhaseRad

See also

fft_image_invFftImageInv

Module🔗

Foundation