Operator Reference

phase_degphase_degPhaseDegPhaseDegphase_deg (Operator)

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

Signature

phase_deg(ImageComplex : ImagePhase : : )

Herror phase_deg(const Hobject ImageComplex, Hobject* ImagePhase)

Herror T_phase_deg(const Hobject ImageComplex, Hobject* ImagePhase)

void PhaseDeg(const HObject& ImageComplex, HObject* ImagePhase)

HImage HImage::PhaseDeg() const

static void HOperatorSet.PhaseDeg(HObject imageComplex, out HObject imagePhase)

HImage HImage.PhaseDeg()

def phase_deg(image_complex: HObject) -> HObject

Description

phase_degphase_degPhaseDegPhaseDegphase_deg computes the phase of a complex image in degrees. The following formula is used: Hence, ImagePhaseImagePhaseImagePhaseimagePhaseimage_phase contains half the phase angle. For negative phase angles, 180 is added.

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

ImageComplexImageComplexImageCompleximageCompleximage_complex (input_object)  (multichannel-)image(-array) objectHImageHObjectHObjectHobject (complex)

Input image in frequency domain.

ImagePhaseImagePhaseImagePhaseimagePhaseimage_phase (output_object)  image(-array) objectHImageHObjectHObjectHobject * (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_degphase_degPhaseDegPhaseDegphase_deg 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>:)set_system("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>)set_system("no_object_result",<Result>). If necessary, an exception is raised.

Possible Predecessors

fft_imagefft_imageFftImageFftImagefft_image, fft_genericfft_genericFftGenericFftGenericfft_generic, rft_genericrft_genericRftGenericRftGenericrft_generic

Possible Successors

disp_imagedisp_imageDispImageDispImagedisp_image

Alternatives

phase_radphase_radPhaseRadPhaseRadphase_rad

See also

fft_image_invfft_image_invFftImageInvFftImageInvfft_image_inv

Module

Foundation