Main Page | Modules | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

Texture: Utility Functions
[Texture]

This module provides functions that perform some basic operations on the texture_plan data structur. More...

Functions

int texture_flat_index (int l, int m, int n)
 Convert a non-flat index of the frequencies $ \omega $ to a flat index.
int texture_flat_length (int N)
 Determines the length of an array omega storing frequencies in a given bandwidth.
int texture_get_omega_length (texture_plan *ths)
 Returns the length of the frequency array stored in a plan.
int texture_get_x_length (texture_plan *ths)
 Returns the length of the sample array stored in a plan.
int texture_get_N (texture_plan *ths)
 Returns the bandwidth stored in a plan.
int texture_get_N1 (texture_plan *ths)
 Returns the number of pole figures stored in a plan.
int texture_get_N2 (texture_plan *ths)
 Returns the number of samples per pole figure stored in a plan.
const complex * texture_get_omega (texture_plan *ths)
 Returns a pointer to the frequencies stored in a plan.
void texture_set_omega (texture_plan *ths, complex *omega)
 Sets the frequencies in a plan.
const complex * texture_get_x (texture_plan *ths)
 Returns a pointer to the samples stored in a plan.
void texture_set_x (texture_plan *ths, complex *x)
 Sets the samples in a plan.
const double * texture_get_h_phi (texture_plan *ths)
 Returns a pointer to the latitudes of the pole figures stored in a plan.
void texture_set_h_phi (texture_plan *ths, const double *h_phi)
 Sets the latitudes of the pole figures in a plan.
const double * texture_get_h_theta (texture_plan *ths)
 Returns the longitudes of the pole figures stored in a plan.
void texture_set_h_theta (texture_plan *ths, const double *h_theta)
 Sets the longitudes of the pole figures in a plan.
const double * texture_get_r (texture_plan *ths)
 Returns the nodes of the pole figures stored in a plan.
void texture_set_r (texture_plan *ths, const double *r)
 Sets the nodes of the pole figures in a plan.
unsigned int texture_get_nfsft_init_flags (texture_plan *ths)
 Returnes the flags used for the initialisation of the nfsft stored in a plan.
void texture_set_nfsft_init_flags (texture_plan *ths, unsigned int nfsft_init_flags)
 Sets the flags used for the initialisation of the nfsft in a plan.
int texture_get_nfft_cutoff (texture_plan *ths)
 Returns the nfft_cutoff parameter used for the initialisation of the nfsft stored in a plan.
void texture_set_nfft_cutoff (texture_plan *ths, int nfft_cutoff)
 Sets the nfft_cutoff parameter used for the initialisation of the nfsft in a plan.

Detailed Description

This module provides functions that perform some basic operations on the texture_plan data structur.

Author:
Matthias Schmalz

Function Documentation

int texture_flat_index (  int  l,
int  m,
int  n
) 
 

Convert a non-flat index of the frequencies $ \omega $ to a flat index.

See Data Representation for more information.

  • l - the first index
  • m - the second index
  • n - the third index
Returns:
- the flat index
Precondition:
  • $ m \in [-l \dots l] $
  • $ n \in [-l \dots l] $

int texture_flat_length (  int  N  ) 
 

Determines the length of an array omega storing frequencies in a given bandwidth.

N - the bandwidth.
Returns:
the length of the corresponding omega

const double* texture_get_h_phi (  texture_plan *  ths  ) 
 

Returns a pointer to the latitudes of the pole figures stored in a plan.

ths - a pointer to the transformation plan

const double* texture_get_h_theta (  texture_plan *  ths  ) 
 

Returns the longitudes of the pole figures stored in a plan.

ths - a pointer to the transformation plan

int texture_get_N (  texture_plan *  ths  ) 
 

Returns the bandwidth stored in a plan.

ths - a pointer to the transformation plan

int texture_get_N1 (  texture_plan *  ths  ) 
 

Returns the number of pole figures stored in a plan.

ths - a pointer to the transformation plan

int texture_get_N2 (  texture_plan *  ths  ) 
 

Returns the number of samples per pole figure stored in a plan.

ths - a pointer to the transformation plan

int texture_get_nfft_cutoff (  texture_plan *  ths  ) 
 

Returns the nfft_cutoff parameter used for the initialisation of the nfsft stored in a plan.

ths - a pointer to the transformation plan

unsigned int texture_get_nfsft_init_flags (  texture_plan *  ths  ) 
 

Returnes the flags used for the initialisation of the nfsft stored in a plan.

ths - a pointer to the transformation plan

const complex* texture_get_omega (  texture_plan *  ths  ) 
 

Returns a pointer to the frequencies stored in a plan.

ths - a pointer to the transformation plan

int texture_get_omega_length (  texture_plan *  ths  ) 
 

Returns the length of the frequency array stored in a plan.

ths - a pointer to the transformation plan

const double* texture_get_r (  texture_plan *  ths  ) 
 

Returns the nodes of the pole figures stored in a plan.

ths - a pointer to the transformation plan

const complex* texture_get_x (  texture_plan *  ths  ) 
 

Returns a pointer to the samples stored in a plan.

ths - a pointer to the transformation plan

int texture_get_x_length (  texture_plan *  ths  ) 
 

Returns the length of the sample array stored in a plan.

ths - a pointer to the transformation plan

void texture_set_h_phi (  texture_plan *  ths,
const double *  h_phi
) 
 

Sets the latitudes of the pole figures in a plan.

ths - a pointer to the transformation plan
h_phi - a pointer to the new latitudes
Precondition:
h_phi has to point to an array of appropriate length.

void texture_set_h_theta (  texture_plan *  ths,
const double *  h_theta
) 
 

Sets the longitudes of the pole figures in a plan.

ths - a pointer to the transformation plan
h_theta - a pointer to the longitudes
Precondition:
h_theta has to point to an array of appropriate length.

void texture_set_nfft_cutoff (  texture_plan *  ths,
int  nfft_cutoff
) 
 

Sets the nfft_cutoff parameter used for the initialisation of the nfsft in a plan.

ths - a pointer to the transformation plan
nfft_cutoff - the parameter

void texture_set_nfsft_init_flags (  texture_plan *  ths,
unsigned int  nfsft_init_flags
) 
 

Sets the flags used for the initialisation of the nfsft in a plan.

ths - a pointer to the transformation plan
nfsft_init_flags - the nfsft flags

void texture_set_omega (  texture_plan *  ths,
complex *  omega
) 
 

Sets the frequencies in a plan.

ths - a pointer to the transformation plan
omega - a pointer to the new frequencies.
Precondition:
omega has to point to an array of appropriate length.

void texture_set_r (  texture_plan *  ths,
const double *  r
) 
 

Sets the nodes of the pole figures in a plan.

ths - a pointer to the transformation plan
r - a pointer to the nodes
Precondition:
r has to point to an array of appropriate length.

void texture_set_x (  texture_plan *  ths,
complex *  x
) 
 

Sets the samples in a plan.

ths - a pointer to the transformation plan
x - a pointer to the new samples
Precondition:
x has to point to an array of appropriate length.

Generated on Wed May 10 20:39:39 2006 for NFFT by  doxygen 1.4.4