.\" Title: \fBlqr_carver_set_energy_function_builtin\fR
.\" Author: Carlo Baldassi
.\" Generator: DocBook XSL Stylesheets v1.73.2
.\" Date: 10 Maj 2009
.\" Manual: LqR library API reference
.\" Source: LqR library 0.4.1 API (3:1:3)
.\"
.TH "\FBLQR_CARVER_SET_ENERGY_FUNCT" "3" "10 Maj 2009" "LqR library 0.4.1 API (3:1:3)" "LqR library API reference"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
lqr_carver_bias_set_energy_function_builtin \- set a builtin energy function for a LqrCarver object
.SH "SYNOPSIS"
.sp
.ft B
.nf
#include
.fi
.ft
.HP 49
.BI "LqrRetVal lqr_carver_set_energy_function_builtin(LqrCarver*\ " "carver" ", LqrEnergyFuncBuiltinType\ " "ef_ind" ");"
.SH "DESCRIPTION"
.PP
The function
\fBlqr_carver_set_energy_function_builtin\fR
allows to pick a builtin energy function for the
LqrCarver
object pointed to by
\fIcarver\fR\&.
.PP
The possible values for
\fIef_ind\fR
are:
.PP
LQR_EF_GRAD_XABS
.RS 4
absolute value of the brightness gradient in the direction of the rescaling (this is the default)
.RE
.PP
LQR_EF_GRAD_SUMABS
.RS 4
sum of absolute values of the brightness gradients in both directions
.RE
.PP
LQR_EF_GRAD_NORM
.RS 4
norm of the brightness gradient
.RE
.PP
LQR_EF_LUMA_GRAD_XABS
.RS 4
absolute value of the luma gradient in the direction of the rescaling
.RE
.PP
LQR_EF_LUMA_GRAD_SUMABS
.RS 4
sum of absolute values of the luma gradients in both directions
.RE
.PP
LQR_EF_LUMA_GRAD_NORM
.RS 4
norm of the luma gradient
.RE
.PP
LQR_EF_NULL
.RS 4
null
.RE
.PP
All of the above gradient functions have a radius of 1 pixel\&.
.SH "RETURN VALUE"
.PP
The return value follows the Liquid Rescale library signalling system\&.
.SH "SEE ALSO"
.PP
\fBlqr_carver_set_energy_function\fR(3), \fBlqr_carver_get_energy\fR(3)
.SH "COPYRIGHT"
Copyright \(co 2007-2009 Carlo Baldassi
.br