File: hist_entropy.c

package info (click to toggle)
vips 8.14.1-3%2Bdeb12u2
  • links: PTS
  • area: main
  • in suites: bookworm
  • size: 35,912 kB
  • sloc: ansic: 165,449; cpp: 10,987; python: 4,462; xml: 4,212; sh: 471; perl: 40; makefile: 23
file content (159 lines) | stat: -rw-r--r-- 3,932 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/* estimate entropy
 *
 * Author: John Cupitt
 * 11/8/15	
 * 	- from hist_ismonotonic.c
 * 6/3/16
 * 	- vips_log() call was mangled, thanks Lovell
 */

/*

    This file is part of VIPS.
    
    VIPS is free software; you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301  USA

 */

/*

    These files are distributed with VIPS - http://www.vips.ecs.soton.ac.uk

 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif /*HAVE_CONFIG_H*/
#include <glib/gi18n-lib.h>

#include <stdio.h>
#include <math.h>

#include <vips/vips.h>

typedef struct _VipsHistEntropy { 
	VipsOperation parent_instance;

	VipsImage *in;

	double out;
} VipsHistEntropy;

typedef VipsOperationClass VipsHistEntropyClass;

G_DEFINE_TYPE( VipsHistEntropy, vips_hist_entropy, 
	VIPS_TYPE_OPERATION );

static int
vips_hist_entropy_build( VipsObject *object )
{
	VipsObjectClass *class = VIPS_OBJECT_GET_CLASS( object );
	VipsHistEntropy *entropy = (VipsHistEntropy *) object; 
	VipsImage **t = (VipsImage **) vips_object_local_array( object, 4 );

	double avg; 
	double sum; 

	if( VIPS_OBJECT_CLASS( vips_hist_entropy_parent_class )->
		build( object ) )
		return( -1 );

	if( vips_check_hist( class->nickname, entropy->in ) )
		return( -1 );

	/* Compute:
	 *   norm_hist = hist / sum( hist )
	 *   entropy = -sum( norm_hist * log2( norm_hist ) )
	 */
	if( vips_avg( entropy->in, &avg, NULL ) )
		return( -1 );
	sum = avg * VIPS_IMAGE_N_PELS( entropy->in ) * entropy->in->Bands;
	if( vips_linear1( entropy->in, &t[0], 1.0 / sum, 0, NULL ) ||
		vips_log( t[0], &t[1], NULL ) ||
		vips_linear1( t[1], &t[2], 1.0 / log( 2.0 ), 0, NULL ) ||
		vips_multiply( t[0], t[2], &t[3], NULL ) ||
		vips_avg( t[3], &avg, NULL ) )
		return( -1 );

	g_object_set( entropy, 
		"out", -avg * 
			VIPS_IMAGE_N_PELS( entropy->in ) * entropy->in->Bands,
		NULL ); 

	return( 0 );
}

static void
vips_hist_entropy_class_init( VipsHistEntropyClass *class )
{
	GObjectClass *gobject_class = G_OBJECT_CLASS( class );
	VipsObjectClass *object_class = (VipsObjectClass *) class;

	gobject_class->set_property = vips_object_set_property;
	gobject_class->get_property = vips_object_get_property;

	object_class->nickname = "hist_entropy";
	object_class->description = _( "estimate image entropy" );
	object_class->build = vips_hist_entropy_build;

	VIPS_ARG_IMAGE( class, "in", 1, 
		_( "Input" ), 
		_( "Input histogram image" ),
		VIPS_ARGUMENT_REQUIRED_INPUT,
		G_STRUCT_OFFSET( VipsHistEntropy, in ) );

	VIPS_ARG_DOUBLE( class, "out", 2, 
		_( "Output" ), 
		_( "Output value" ),
		VIPS_ARGUMENT_REQUIRED_OUTPUT,
		G_STRUCT_OFFSET( VipsHistEntropy, out ),
		-INFINITY, INFINITY, 0.0 );

}

static void
vips_hist_entropy_init( VipsHistEntropy *entropy )
{
}

/**
 * vips_hist_entropy: (method)
 * @in: input histogram 
 * @out: (out): image entropy
 * @...: %NULL-terminated list of optional named arguments
 *
 * Estimate image entropy from a histogram. Entropy is calculated as:
 *
 * |[
 * -sum( p * log2( p ) )
 * ]|
 *
 * where p is histogram-value / sum-of-histogram-values.
 *
 * Returns: 0 on success, -1 on error
 */
int 
vips_hist_entropy( VipsImage *in, double *out, ... )
{
	va_list ap;
	int result;

	va_start( ap, out );
	result = vips_call_split( "hist_entropy", ap, in, out );
	va_end( ap );

	return( result );
}