hkl-lattice

hkl-lattice

Synopsis

                    HklLattice;
HklLattice *        hkl_lattice_new                     (double a,
                                                         double b,
                                                         double c,
                                                         double alpha,
                                                         double beta,
                                                         double gamma);
HklLattice *        hkl_lattice_new_copy                (HklLattice const *self);
HklLattice *        hkl_lattice_new_default             (void);
void                hkl_lattice_free                    (HklLattice *self);
int                 hkl_lattice_set                     (HklLattice *self,
                                                         double a,
                                                         double b,
                                                         double c,
                                                         double alpha,
                                                         double beta,
                                                         double gamma);
int                 hkl_lattice_get_B                   (HklLattice const *self,
                                                         HklMatrix *B);
int                 hkl_lattice_get_1_B                 (const HklLattice *self,
                                                         HklMatrix *B);
int                 hkl_lattice_reciprocal              (HklLattice const *self,
                                                         HklLattice *r);
void                hkl_lattice_randomize               (HklLattice *self);
void                hkl_lattice_fprintf                 (FILE *f,
                                                         HklLattice const *self);

Description

Details

HklLattice

typedef struct {
	HklParameter *a;
	HklParameter *b;
	HklParameter *c;
	HklParameter *alpha;
	HklParameter *beta;
	HklParameter *gamma;
} HklLattice;


hkl_lattice_new ()

HklLattice *        hkl_lattice_new                     (double a,
                                                         double b,
                                                         double c,
                                                         double alpha,
                                                         double beta,
                                                         double gamma);

a :

b :

c :

alpha :

beta :

gamma :

Returns :


hkl_lattice_new_copy ()

HklLattice *        hkl_lattice_new_copy                (HklLattice const *self);

self :

Returns :


hkl_lattice_new_default ()

HklLattice *        hkl_lattice_new_default             (void);

Returns :


hkl_lattice_free ()

void                hkl_lattice_free                    (HklLattice *self);

self :


hkl_lattice_set ()

int                 hkl_lattice_set                     (HklLattice *self,
                                                         double a,
                                                         double b,
                                                         double c,
                                                         double alpha,
                                                         double beta,
                                                         double gamma);

self :

a :

b :

c :

alpha :

beta :

gamma :

Returns :


hkl_lattice_get_B ()

int                 hkl_lattice_get_B                   (HklLattice const *self,
                                                         HklMatrix *B);

self :

B :

Returns :


hkl_lattice_get_1_B ()

int                 hkl_lattice_get_1_B                 (const HklLattice *self,
                                                         HklMatrix *B);

Compute the invert of B (needed by the hkl_sample_set_UB method) should be optimized

self :

the HklLattice

B :

the HklMatrix returned

Returns :

HKL_SUCCESS or HKL_FAIL depending of the success of the computation.

hkl_lattice_reciprocal ()

int                 hkl_lattice_reciprocal              (HklLattice const *self,
                                                         HklLattice *r);

self :

r :

Returns :


hkl_lattice_randomize ()

void                hkl_lattice_randomize               (HklLattice *self);

self :


hkl_lattice_fprintf ()

void                hkl_lattice_fprintf                 (FILE *f,
                                                         HklLattice const *self);

f :

self :