You are reading the documentation for version 2.3 of OpenStructure. You may also want to read the documentation for:
1.1
1.2
1.3
1.4
1.5
1.6
1.7
1.7.1
1.8
1.9
1.10
1.11
2.0
2.1
2.2
2.3.1
devel

Parameters:  block_size (Size ) – Size of the blocks to be merged 

FFT
¶This algorithm performs a Fourier Transform of the image, without honoring
its The spatial origin (See DFT
)
LowPassFilter
(cutoff=1.0)¶This algorithm applies a Fourier low pass filter to the image. The filter cutoff frequency needs to be provided in sampling units (for example 8 Angstrom). Please notice that this filter features a sharp dropoff.
Parameters:  cutoff (float) – Frequency cutoff in sampling units 

GetLimit
()¶Returns the current value of the filter cutoff frequency (in sampling units).
Return type:  float 

SetLimit
(cutoff)¶Sets the value of the filter cutoff frequency to the specified value (in sampling units).
Parameters:  cutoff (float) – Frequency cutoff in sampling units 

HighPassFilter
(cutoff=1.0)¶This algorithm applies a Fourier high pass filter to the image. The filter cutoff frequency needs to be provided in sampling units (for example 8 Angstrom). Please notice that this filter features a sharp dropoff.
Parameters:  cutoff (float) – Frequency cutoff in sampling units 

GetLimit
()¶Returns the current value of the filter cutoff frequency (in sampling units).
Return type:  float 

SetLimit
(cutoff)¶Sets the value of the filter cutoff frequency to the specified value (in sampling units).
Parameters:  cutoff (float) – Frequency cutoff in sampling units 

GaussianLowPassFilter
(cutoff=1.0)¶This algorithm applies a Fourier Gaussian low pass filter to the image. The filter cutoff frequency needs to be provided in sampling units (for example 8 Angstrom).
Parameters:  cutoff (float) – Frequency cutoff in sampling units 

GetLimit
()¶Returns the current value of the filter cutoff frequency (in sampling units).
Return type:  float 

SetLimit
(cutoff)¶Sets the value of the filter cutoff frequency to the specified value (in sampling units).
Parameters:  cutoff (float) – Frequency cutoff in sampling units 

GaussianHighPassFilter
(cutoff=1.0)¶This algorithm applies a Fourier Gaussian High pass filter to the image. The filter cutoff frequency needs to be provided in sampling units (for example 8 Angstrom).
Parameters:  cutoff (float) – Frequency cutoff in sampling units 

GetLimit
()¶Returns the current value of the filter cutoff frequency (in sampling units).
Return type:  float 

SetLimit
(cutoff)¶Sets the value of the filter cutoff frequency to the specified value (in sampling units).
Parameters:  cutoff (float) – Frequency cutoff in sampling units 

FermiLowPassFilter
(cutoff=1.0, t=1.0)¶This algorithm applies a Fourier Fermi low pass filter to the image. The filter cutoff frequency and the temperature parameter T need to be provided in sampling units (for example 8 Angstrom).
Parameters: 


GetLimit
()¶Returns the current value of the filter cutoff frequency in sampling units.
Return type:  float 

SetLimit
(cutoff)¶Sets the value of the filter cutoff frequency to the specified value (in sampling units).
Parameters:  cutoff (float) – Frequency cutoff in sampling units 

GetT
()¶Returns the current value of the filter’s T factor (in sampling units).
Return type:  float 

SetT
(t_factor)¶Sets the value of the filter’s T factor to the specified value (in sampling units).
Parameters:  t_factor (float) – Frequency cutoff in sampling units 

FermiHighPassFilter
(cutoff=1.0, t=1.0)¶This algorithm applies a Fourier Fermi high pass filter to the image. The filter cutoff frequency and the temperature parameter T need to be provided in sampling units (for example 8 Angstrom).
Parameters: 


GetLimit
()¶Returns the current value of the filter cutoff frequency in sampling units.
Return type:  float 

SetLimit
(cutoff)¶Sets the value of the filter cutoff frequency to the specified value (in sampling units).
Parameters:  cutoff (float) – Frequency cutoff in sampling units 

GetT
()¶Returns the current value of the filter’s T factor (in sampling units).
Return type:  float 

SetT
(t_factor)¶Sets the value of the filter’s T factor to the specified value (in sampling units).
Parameters:  t_factor (float) – Frequency cutoff in sampling units 

ButterworthLowPassFilter
(passband=1.0, stopband=1.0)¶This algorithm applies a Fourier Butterworth low pass filter to the image. The filter passband and stopband frequencies need to be provided in sampling units (for example 8 Angstrom). The default values of the Epsilon and Maximum Passband Gain parameters are set to 0.882 and 10.624 respectively.
Parameters: 


GetLimit
()¶Returns the current value of the filter passband frequency in sampling units.
Return type:  float 

SetLimit
(passband)¶Sets the value of the filter passband frequency to the specified value (in sampling units).
Parameters:  passband (float) – Frequency cutoff in sampling units 

GetStop
()¶Returns the current value of the filter’s stopband frequency (in sampling units).
Return type:  float 

SetStop
(stopband)¶Sets the value of the filter’s stopband frequency to the specified value (in sampling units).
Parameters:  stopband (float) – Frequency cutoff in sampling units 

GetEps
()¶Returns the current value of the filter’s Epsilon parameter.
Return type:  float 

SetEps
(epsilon)¶Sets the value of the filter’s epsilon parameter to the specified value.
Parameters:  eps (float) – Epsilon parameter 

GetA
()¶Returns the current value of the filter’s Maximum Passband Gain parameter.
Return type:  float 

SetA
(gain)¶Sets the value of the filter’s Maximum Passband Gain parameter to the specified value.
Parameters:  gain (float) – Maximum Passband Gain parameter 

ButterworthHighPassFilter
(passband=1.0, stopband=1.0)¶This algorithm applies a Fourier Butterworth high pass filter to the image. The filter passband and stopband frequencies need to be provided in sampling units (for example 8 Angstrom). The default values of the Epsilon and Maximum Passband Gain parameters are set to 0.882 and 10.624 respectively.
Parameters: 


GetLimit
()¶Returns the current value of the filter passband frequency in sampling units.
Return type:  float 

SetLimit
(passband)¶Sets the value of the filter passband frequency to the specified value (in sampling units).
Parameters:  passband (float) – Frequency cutoff in sampling units 

GetStop
()¶Returns the current value of the filter’s stopband frequency (in sampling units).
Return type:  float 

SetStop
(stopband)¶Sets the value of the filter’s stopband frequency to the specified value (in sampling units).
Parameters:  stopband (float) – Frequency cutoff in sampling units 

GetEps
()¶Returns the current value of the filter’s Epsilon parameter.
Return type:  float 

SetEps
(epsilon)¶Sets the value of the filter’s epsilon parameter to the specified value.
Parameters:  eps (float) – Epsilon parameter 

GetA
()¶Returns the current value of the filter’s Maximum Passband Gain parameter.
Return type:  float 

SetA
(gain)¶Sets the value of the filter’s Maximum Passband Gain parameter to the specified value.
Parameters:  gain (float) – Maximum Passband Gain parameter 

GaussianFilter
(sigma=1.0)¶This algorithm applies a real space Gaussian filter to the image, as defined in the following publication:
I.T.Young, L.J. van Vliet,”Recursive implementation of the Gaussian filter”,Signal Processing, 44(1995), 139151
Parameters:  sigma (float) – Width of the Gaussian filter 

GetSigma
()¶Returns the current value of the filter’s width.
Return type:  float 

SetSigma
(width)¶Sets the value of the filter’s width to the specified value.
Parameters:  sigma (float) – Width of the Gaussian filter 

SetQ
(q_param)¶Sets the value of the filter’s Q parameter (see publication) to the specified value.
Parameters:  q_param (float) – Filter’s Q parameter 

Histogram
(bins, minimum, maximum)¶This algorithm performs an histogram analysis of the image. The minimum and maximum pixel values of the histogram representation must be provided when the algorithm object is created, as well as the number of bins in the histogram. Bins are equally spaced and minimum and maximum values for each bin are automatically computed.
When the algorithm is applied to an image, the analysis is carried out. A python ‘list’ object containing in sequence the pixel counts for all the bins can the be recovered from the algorithm object.
Parameters: 


GetBins
()¶Returns the bins of the histogram representation
Return type:  list of ints 

GetBins
()Enter search terms or a module, class or function name.
seq
– Sequences and Alignments
img.alg
 Image Processing Algorithms