rt_band_set_nodata()

rt_errorstate rt_band_set_nodata	(	rt_band	band,
		double	val,
		int *	converted
	)

Set nodata value.

Parameters

band	: the band to set nodata value to
val	: the nodata value
converted	: if non-zero, value was truncated/clamped/converted

Returns

ES_NONE or ES_ERROR

Definition at line 892 of file rt_band.c.

                                                             {
        rt_pixtype pixtype = PT_END;
        int32_t checkvalint = 0;
        uint32_t checkvaluint = 0;
        float checkvalfloat = 0;
        double checkvaldouble = 0;
 
        assert(NULL != band);
 
        if (converted != NULL)
                *converted = 0;
 
        pixtype = band->pixtype;
 
        RASTER_DEBUGF(3, "rt_band_set_nodata: setting nodata value %g with band type %s", val, rt_pixtype_name(pixtype));
 
        /* return -1 on out of range */
        switch (pixtype) {
                case PT_1BB: {
                        band->nodataval = rt_util_clamp_to_1BB(val);
                        checkvalint = band->nodataval;
                        break;
                }
                case PT_2BUI: {
                        band->nodataval = rt_util_clamp_to_2BUI(val);
                        checkvalint = band->nodataval;
                        break;
                }
                case PT_4BUI: {
                        band->nodataval = rt_util_clamp_to_4BUI(val);
                        checkvalint = band->nodataval;
                        break;
                }
                case PT_8BSI: {
                        band->nodataval = rt_util_clamp_to_8BSI(val);
                        checkvalint = band->nodataval;
                        break;
                }
                case PT_8BUI: {
                        band->nodataval = rt_util_clamp_to_8BUI(val);
                        checkvalint = band->nodataval;
                        break;
                }
                case PT_16BSI: {
                        band->nodataval = rt_util_clamp_to_16BSI(val);
                        checkvalint = band->nodataval;
                        break;
                }
                case PT_16BUI: {
                        band->nodataval = rt_util_clamp_to_16BUI(val);
                        checkvalint = band->nodataval;
                        break;
                }
                case PT_32BSI: {
                        band->nodataval = rt_util_clamp_to_32BSI(val);
                        checkvalint = band->nodataval;
                        break;
                }
                case PT_32BUI: {
                        band->nodataval = rt_util_clamp_to_32BUI(val);
                        checkvaluint = band->nodataval;
                        break;
                }
                case PT_16BF: {
                        float half = rt_util_clamp_to_16F(val);
                        /* Persist the exact half-float encoding so nodata comparisons stay bitwise-stable. */
                        band->nodataval = rt_util_float16_to_float(rt_util_float_to_float16(half));
                        checkvalfloat = (float)band->nodataval;
                        break;
                }
                case PT_32BF: {
                        band->nodataval = rt_util_clamp_to_32F(val);
                        checkvalfloat = band->nodataval;
                        break;
                }
                case PT_64BF: {
                        band->nodataval = val;
                        checkvaldouble = band->nodataval;
                        break;
                }
                default: {
                        rterror("rt_band_set_nodata: Unknown pixeltype %d", pixtype);
                        band->hasnodata = 0;
                        return ES_ERROR;
                }
        }
 
        RASTER_DEBUGF(3, "rt_band_set_nodata: band->hasnodata = %d", band->hasnodata);
        RASTER_DEBUGF(3, "rt_band_set_nodata: band->nodataval = %f", band->nodataval);
        /* the nodata value was just set, so this band has NODATA */
        band->hasnodata = 1;
 
        /* also set isnodata flag to false */
        band->isnodata = 0;
 
        if (rt_util_dbl_trunc_warning(
                val,
                checkvalint, checkvaluint,
                checkvalfloat, checkvaldouble,
                pixtype
        ) && converted != NULL) {
                *converted = 1;
        }
 
        return ES_NONE;
}

References ES_ERROR, ES_NONE, PT_16BF, PT_16BSI, PT_16BUI, PT_1BB, PT_2BUI, PT_32BF, PT_32BSI, PT_32BUI, PT_4BUI, PT_64BF, PT_8BSI, PT_8BUI, PT_END, RASTER_DEBUGF, rt_pixtype_name(), rt_util_clamp_to_16BSI(), rt_util_clamp_to_16BUI(), rt_util_clamp_to_16F(), rt_util_clamp_to_1BB(), rt_util_clamp_to_2BUI(), rt_util_clamp_to_32BSI(), rt_util_clamp_to_32BUI(), rt_util_clamp_to_32F(), rt_util_clamp_to_4BUI(), rt_util_clamp_to_8BSI(), rt_util_clamp_to_8BUI(), rt_util_dbl_trunc_warning(), rt_util_float16_to_float(), rt_util_float_to_float16(), and rterror().

Referenced by RASTER_setBandNoDataValue(), rt_band_new_inline(), rt_band_new_offline(), test_band_metadata(), test_band_pixtype_16BSI(), test_band_pixtype_16BUI(), test_band_pixtype_1BB(), test_band_pixtype_2BUI(), test_band_pixtype_32BF(), test_band_pixtype_32BSI(), test_band_pixtype_32BUI(), test_band_pixtype_4BUI(), test_band_pixtype_64BF(), test_band_pixtype_8BSI(), test_band_pixtype_8BUI(), test_band_reclass(), test_band_stats(), test_band_value_count(), test_raster_colormap(), test_raster_from_band(), test_raster_fully_within_distance(), test_raster_geos_contains(), test_raster_geos_contains_properly(), test_raster_geos_covered_by(), test_raster_geos_covers(), test_raster_geos_overlaps(), test_raster_geos_touches(), test_raster_intersects(), and test_raster_within_distance().

Here is the call graph for this function:

Here is the caller graph for this function: