NcmLHRatio2d

NcmLHRatio2d — Likelihood ratio object for bidimensional parameter analysis.

Functions

NcmLHRatio2d * ncm_lh_ratio2d_new ()
void ncm_lh_ratio2d_free ()
void ncm_lh_ratio2d_clear ()
void ncm_lh_ratio2d_set_pindex ()
NcmLHRatio2dRegion * ncm_lh_ratio2d_conf_region ()
NcmLHRatio2dRegion * ncm_lh_ratio2d_fisher_border ()
NcmLHRatio2dRegion * ncm_lh_ratio2d_region_dup ()
void ncm_lh_ratio2d_region_free ()
void ncm_lh_ratio2d_region_clear ()
void ncm_lh_ratio2d_region_print ()

Properties

double border-prec Read / Write / Construct
NcmFit * fit Write / Construct Only
NcmMSetPIndex * pi1 Read / Write / Construct
NcmMSetPIndex * pi2 Read / Write / Construct

Types and Values

#define NCM_TYPE_LH_RATIO2D
enum NcmLHRatio2dRoot
struct NcmLHRatio2dRegion
  NcmLHRatio2d

Object Hierarchy

    GBoxed
    ╰── NcmLHRatio2dRegion
    GEnum
    ╰── NcmLHRatio2dRoot
    GObject
    ╰── NcmLHRatio2d

Description

Class for likelihood ratio analysis of two parameters.

Functions

ncm_lh_ratio2d_new ()

NcmLHRatio2d *
ncm_lh_ratio2d_new (NcmFit *fit,
                    const NcmMSetPIndex *pi1,
                    const NcmMSetPIndex *pi2,
                    gdouble border_prec);

Creates a new NcmLHRatio2d object. The parameters pi1 and pi2 must be parameters of the model set of fit .

Parameters

fit

a NcmFit

  

pi1

a NcmMSetPIndex for the first parameter

  

pi2

a NcmMSetPIndex for the second parameter

  

border_prec

precision on the border finder.

  

Returns

a new NcmLHRatio2d.

[transfer full]

ncm_lh_ratio2d_free ()

void
ncm_lh_ratio2d_free (NcmLHRatio2d *lhr2d);

Decreases the reference count of lhr2d by one. If the reference count reaches zero, all memory allocated by lhr2d is released.

Parameters

lhr2d

a NcmLHRatio2d

  

ncm_lh_ratio2d_clear ()

void
ncm_lh_ratio2d_clear (NcmLHRatio2d **lhr2d);

If lhr2d is not NULL, decreases its reference count by one and sets lhr2d to NULL.

Parameters

lhr2d

a NcmLHRatio2d

  

ncm_lh_ratio2d_set_pindex ()

void
ncm_lh_ratio2d_set_pindex (NcmLHRatio2d *lhr2d,
                           NcmMSetPIndex *pi1,
                           NcmMSetPIndex *pi2);

Sets the parameters to be used in the likelihood ratio analysis.

Parameters

lhr2d

a NcmLHRatio2d

  

pi1

a NcmMSetPIndex for the first parameter

  

pi2

a NcmMSetPIndex for the second parameter

  

ncm_lh_ratio2d_conf_region ()

NcmLHRatio2dRegion *
ncm_lh_ratio2d_conf_region (NcmLHRatio2d *lhr2d,
                            gdouble clevel,
                            gdouble expected_np,
                            NcmFitRunMsgs mtype);

Computes the confidence region with the given clevel .

Parameters

lhr2d

a NcmLHRatio2d

 

clevel

confidence level

  

expected_np

Expected number of points, if lesser than 1 it uses the default value of 100.

  

mtype

a NcmFitRunMsgs

  

Returns

a NcmLHRatio2dRegion.

[transfer full]

ncm_lh_ratio2d_fisher_border ()

NcmLHRatio2dRegion *
ncm_lh_ratio2d_fisher_border (NcmLHRatio2d *lhr2d,
                              gdouble clevel,
                              gdouble expected_np,
                              NcmFitRunMsgs mtype);

Computes the Fisher border with the given clevel .

Parameters

lhr2d

a NcmFit.

  

clevel

confidence level

  

expected_np

Expected number of points, if lesser than 1 it uses the default value of 600.

  

mtype

a NcmFitRunMsgs

  

Returns

a NcmLHRatio2dRegion.

[transfer full]

ncm_lh_ratio2d_region_dup ()

NcmLHRatio2dRegion *
ncm_lh_ratio2d_region_dup (NcmLHRatio2dRegion *rg);

Duplicates a NcmLHRatio2dRegion.

Parameters

rg

a NcmLHRatio2dRegion.

  

Returns

a NcmLHRatio2dRegion.

[transfer full]

ncm_lh_ratio2d_region_free ()

void
ncm_lh_ratio2d_region_free (NcmLHRatio2dRegion *rg);

Frees a NcmLHRatio2dRegion.

Parameters

rg

a NcmLHRatio2dRegion.

  

ncm_lh_ratio2d_region_clear ()

void
ncm_lh_ratio2d_region_clear (NcmLHRatio2dRegion **rg);

If rg is not NULL, frees a NcmLHRatio2dRegion and sets rg to NULL.

Parameters

rg

a NcmLHRatio2dRegion.

  

ncm_lh_ratio2d_region_print ()

void
ncm_lh_ratio2d_region_print (NcmLHRatio2dRegion *rg,
                             FILE *out);

Prints the region to the file handler out .

Parameters

rg

a NcmLHRatio2dRegion

  

out

a file handler to print to

  

Types and Values

NCM_TYPE_LH_RATIO2D

#define NCM_TYPE_LH_RATIO2D (ncm_lh_ratio2d_get_type ())

enum NcmLHRatio2dRoot

Root finding methods used by NcmLHRatio2d.

Members

NCM_LH_RATIO2D_ROOT_BRACKET

Root finding by bracketing

  

NCM_LH_RATIO2D_ROOT_NUMDIFF

Root finding by numerical differentiation

  

struct NcmLHRatio2dRegion

struct NcmLHRatio2dRegion {
  guint np;
  NcmVector *p1;
  NcmVector *p2;
  gdouble clevel;
};

Object describing a confidence region.

Members

guint np;

Number of points.

  

NcmVector *p1;

a NcmVector containing points of parameter one.

  

NcmVector *p2;

a NcmVector containing points of parameter two.

  

gdouble clevel;

the confidence level represented by the border.

  

NcmLHRatio2d

typedef struct _NcmLHRatio2d NcmLHRatio2d;

Property Details

The “border-prec” property

  “border-prec”              double

Border precision.

Owner: NcmLHRatio2d

Flags: Read / Write / Construct

Allowed values: [1e-16,1000]

Default value: 1e-05

The “fit” property

  “fit”                      NcmFit *

NcmFit object.

Owner: NcmLHRatio2d

Flags: Write / Construct Only

The “pi1” property

  “pi1”                      NcmMSetPIndex *

First param index.

Owner: NcmLHRatio2d

Flags: Read / Write / Construct

The “pi2” property

  “pi2”                      NcmMSetPIndex *

Second param index.

Owner: NcmLHRatio2d

Flags: Read / Write / Construct

Generated by GTK-Doc V1.34.0