local_metrics.hpp

Go to the documentation of this file.

/* Copyright (c) 2023 Otto Link. Distributed under the terms of the GNU General
   Public License. The full license is in the file LICENSE, distributed with
   this software. */
 
#pragma once
 
#include "highmap/array.hpp"
 
namespace hmap
{
 
Array local_max(const Array &array, int ir);
 
Array local_median_deviation(const Array &array, int ir);
 
Array local_min(const Array &array, int ir);
 
Array local_mean(const Array &array, int ir);
 
Array relative_elevation(const Array &array, int ir);
 
Array ruggedness(const Array &array, int ir);
 
Array rugosity(const Array &z, int ir, bool convex = true);
 
Array valley_width(const Array &z, int ir = 0, bool ridge_select = false);
 
} // namespace hmap
 
namespace hmap::gpu
{
 
Array local_aspect_variance(const Array &array, int ir);
 
Array local_max(const Array &array, int ir);
 
Array local_median_deviation(const Array &array, int ir);
 
Array local_min(const Array &array, int ir);
 
Array local_relief(const Array &array, int ir);
 
Array local_variance(const Array &array, int ir);
 
Array local_mean(const Array &array, int ir);
 
Array local_skewness(const Array &array, int ir);
 
Array local_z_score(const Array &array, int ir);
 
Array topographic_position_index(const Array &array, int ir);
 
Array relative_elevation(const Array &array, int ir);
 
Array relative_elevation_square_kernel(const Array &array, int ir);
 
Array ruggedness(const Array &array, int ir);
 
Array rugosity(const Array &z, int ir, bool convex = true);
 
Array valley_width(const Array &z, int ir = 0, bool ridge_select = false);
 
} // namespace hmap::gpu
 
// ==========================================================================
//  Wrapper
// ==========================================================================
 
namespace hmap::gpu
{
 
// clang-format off
enum LocalMetrics : int
{
    LM_LOCAL_ASPECT_VARIANCE,      
    LM_LOCAL_MAX,                  
    LM_LOCAL_MEDIAN_DEVIATION,     
    LM_LOCAL_MIN,                  
    LM_LOCAL_RELIEF,               
    LM_LOCAL_VARIANCE,             
    LM_LOCAL_MEAN,                 
    LM_LOCAL_SKEWNESS,             
    LM_LOCAL_Z_SCORE,              
    LM_TOPOGRAPHIC_POSITION_INDEX, 
    LM_RELATIVE_ELEVATION,         
    LM_RUGGEDNESS,                 
    LM_RUGOSITY_CONCAVE,           
    LM_RUGOSITY_CONVEX,            
};
// clang-format on
 
Array local_metrics(const Array &array, int ir, LocalMetrics metric);
 
} // namespace hmap::gpu